chore: Update discovery artifacts (#2720)
## Deleted keys were detected in the following stable discovery artifacts:
alloydb v1 https://togithub.com/googleapis/google-api-python-client/commit/92a2635d0eca81c168d1d0786b200e9d3fd1085d
recommender v1 https://togithub.com/googleapis/google-api-python-client/commit/84cdc072380a5aa914905e6cb82baed1fe620f0b
redis v1 https://togithub.com/googleapis/google-api-python-client/commit/cbc9e72bb6996693f2d238c2215de77907e5dd8e
sqladmin v1 https://togithub.com/googleapis/google-api-python-client/commit/62fa87d808bd2c45464a40b604c22de75128fd4b
## Deleted keys were detected in the following pre-stable discovery artifacts:
alloydb v1alpha https://togithub.com/googleapis/google-api-python-client/commit/92a2635d0eca81c168d1d0786b200e9d3fd1085d
alloydb v1beta https://togithub.com/googleapis/google-api-python-client/commit/92a2635d0eca81c168d1d0786b200e9d3fd1085d
compute alpha https://togithub.com/googleapis/google-api-python-client/commit/ab612210ae1ec06165e40009aa1e4d5a2cb515b6
discoveryengine v1alpha https://togithub.com/googleapis/google-api-python-client/commit/a75b5b630d6653d467ca012ab18a193c95780d66
recommender v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/84cdc072380a5aa914905e6cb82baed1fe620f0b
redis v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/cbc9e72bb6996693f2d238c2215de77907e5dd8e
## Discovery Artifact Change Summary:
feat(admin): update the api https://togithub.com/googleapis/google-api-python-client/commit/2b6b2f0e2d0bd73d41c40d648bee6b306e39aa6a
feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/be464c2867ea9c1eb28fa14d6b31fe49cd4c3695
feat(alloydb): update the api https://togithub.com/googleapis/google-api-python-client/commit/92a2635d0eca81c168d1d0786b200e9d3fd1085d
feat(apihub): update the api https://togithub.com/googleapis/google-api-python-client/commit/967265057c77f843f1fa45c56c4e3f7bb29d914a
feat(biglake): update the api https://togithub.com/googleapis/google-api-python-client/commit/054c216436d8cee1466f862ea852e39bf43d64ac
feat(bigtableadmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/f52a42de3831873d99b9a74fec738a987ee9b683
feat(ces): update the api https://togithub.com/googleapis/google-api-python-client/commit/83706703c97ee42d72722eb91032ebf4da298bd1
feat(chat): update the api https://togithub.com/googleapis/google-api-python-client/commit/d702c10623d33006772db6acb993a217fbd7b241
feat(clouderrorreporting): update the api https://togithub.com/googleapis/google-api-python-client/commit/8397666dd7a1d118e2a0fa71683fdb6487d040b2
feat(cloudfunctions): update the api https://togithub.com/googleapis/google-api-python-client/commit/9bbd5f9a72d828821037667bed407e7e02559836
feat(cloudkms): update the api https://togithub.com/googleapis/google-api-python-client/commit/07957adede81dd3fe5084d83f5e7678712bd6323
feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/ab612210ae1ec06165e40009aa1e4d5a2cb515b6
feat(connectors): update the api https://togithub.com/googleapis/google-api-python-client/commit/7d8951d76f6885bf1fc5d05882f4d3d57ff4b8c9
feat(container): update the api https://togithub.com/googleapis/google-api-python-client/commit/e6516edeea075c2940a49355ff4ee2d366116cef
feat(dataflow): update the api https://togithub.com/googleapis/google-api-python-client/commit/11cf3f230ea08425f80d14857d4e198fab7fa993
feat(dataplex): update the api https://togithub.com/googleapis/google-api-python-client/commit/4d4de988832c4bd1dc5d5a98d0a0bc68b3796232
feat(datastream): update the api https://togithub.com/googleapis/google-api-python-client/commit/bbc74ef1e00b071bdbe37104e320d5cc643e57d8
feat(dfareporting): update the api https://togithub.com/googleapis/google-api-python-client/commit/ec13ccadac897ef35b999abfe4d3369693910863
feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/a75b5b630d6653d467ca012ab18a193c95780d66
feat(displayvideo): update the api https://togithub.com/googleapis/google-api-python-client/commit/0e758cc029e0472bc647484869cc3bfe0ca37ab4
fix(eventarc): update the api https://togithub.com/googleapis/google-api-python-client/commit/e1f05dc0058b7e168ad4179c3c6c5ac16b67e699
feat(iap): update the api https://togithub.com/googleapis/google-api-python-client/commit/e77f0b757f48456d22af091b03285475649ff297
feat(networkservices): update the api https://togithub.com/googleapis/google-api-python-client/commit/ea5d2fcfa8ceb7e514f32fc7b9e30184af49ec11
feat(ondemandscanning): update the api https://togithub.com/googleapis/google-api-python-client/commit/87a15fe7d9d615009e3b5cc8a04a12978bcaa9b9
feat(oracledatabase): update the api https://togithub.com/googleapis/google-api-python-client/commit/c2f4ff14d66eeedaffcdbef19e54baa70ae33dc7
feat(places): update the api https://togithub.com/googleapis/google-api-python-client/commit/0c653043695aa838777e7f4694387ead884dbb18
feat(recommender): update the api https://togithub.com/googleapis/google-api-python-client/commit/84cdc072380a5aa914905e6cb82baed1fe620f0b
feat(redis): update the api https://togithub.com/googleapis/google-api-python-client/commit/cbc9e72bb6996693f2d238c2215de77907e5dd8e
feat(run): update the api https://togithub.com/googleapis/google-api-python-client/commit/58d2968e5443fdde314b45258cea6d3fda7c008e
feat(serviceconsumermanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/b277e6318cea8affb6c68055523d03c6ec7a7622
feat(serviceusage): update the api https://togithub.com/googleapis/google-api-python-client/commit/b254a68e048119949160e85657c361469c27178c
feat(sqladmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/62fa87d808bd2c45464a40b604c22de75128fd4b
feat(storage): update the api https://togithub.com/googleapis/google-api-python-client/commit/85343ca96f46b1b9821f1984d8b3d2a088687b89
feat(storagebatchoperations): update the api https://togithub.com/googleapis/google-api-python-client/commit/702630c2dcf09ef4f62f7e798fa2d3b029c34e6b
feat(threatintelligence): update the api https://togithub.com/googleapis/google-api-python-client/commit/e1eee84616032c196ef3a8576df257b87be366f2
feat(workloadmanager): update the api https://togithub.com/googleapis/google-api-python-client/commit/8824958c10675d6da1115322928935bd17aff403
diff --git a/docs/dyn/admin_directory_v1.customer.devices.chromeos.html b/docs/dyn/admin_directory_v1.customer.devices.chromeos.html
index 94f2481..aa3be2d 100644
--- a/docs/dyn/admin_directory_v1.customer.devices.chromeos.html
+++ b/docs/dyn/admin_directory_v1.customer.devices.chromeos.html
@@ -86,6 +86,9 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
+ <code><a href="#countChromeOsDevices">countChromeOsDevices(customerId, filter=None, includeChildOrgunits=None, orgUnitPath=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Counts ChromeOS devices matching the request.</p>
+<p class="toc_element">
<code><a href="#issueCommand">issueCommand(customerId, deviceId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Issues a command for the device to execute.</p>
<h3>Method Details</h3>
@@ -140,6 +143,28 @@
</div>
<div class="method">
+ <code class="details" id="countChromeOsDevices">countChromeOsDevices(customerId, filter=None, includeChildOrgunits=None, orgUnitPath=None, x__xgafv=None)</code>
+ <pre>Counts ChromeOS devices matching the request.
+
+Args:
+ customerId: string, Required. Immutable ID of the Google Workspace account. (required)
+ filter: string, Optional. Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators
+ includeChildOrgunits: boolean, Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.
+ orgUnitPath: string, Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A response for counting ChromeOS devices.
+ "count": "A String", # The total number of devices matching the request.
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="issueCommand">issueCommand(customerId, deviceId, body=None, x__xgafv=None)</code>
<pre>Issues a command for the device to execute.
diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html
index 344de82..6e39670 100644
--- a/docs/dyn/admin_reports_v1.activities.html
+++ b/docs/dyn/admin_reports_v1.activities.html
@@ -78,7 +78,7 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#list">list(userKey, applicationName, actorIpAddress=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides. </p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
@@ -93,7 +93,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(userKey, applicationName, actorIpAddress=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(userKey, applicationName, actorIpAddress=None, applicationInfoFilter=None, customerId=None, endTime=None, eventName=None, filters=None, groupIdFilter=None, maxResults=None, networkInfoFilter=None, orgUnitID=None, pageToken=None, resourceDetailsFilter=None, startTime=None, statusFilter=None, x__xgafv=None)</code>
<pre>Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.
Args:
@@ -139,16 +139,19 @@
takeout - The Takeout application's activity reports return information about various types of Takeout activity events.
graduation - The Graduation application's activity reports return information about various types of Graduation activity events.
actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.
+ applicationInfoFilter: string, Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```
customerId: string, The unique ID of the customer to retrieve data for.
endTime: string, Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days.
eventName: string, The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.
filters: string, The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request's parameter doesn't belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded in the request's query string (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—'equal to'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
groupIdFilter: string, Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)
maxResults: integer, Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
+ networkInfoFilter: string, Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode="IN" GET...&networkInfoFilter=regionCode=%22IN%22 ```
orgUnitID: string, ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.
pageToken: string, The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.
resourceDetailsFilter: string, Optional. The `resourceDetailsFilter` query string is an AND separated list composed of [Resource Details](#resourcedetails) fields manipulated by relational operators. Resource Details Filters are in the form `{resourceDetails.field1}{relational operator}{field1 value} AND {resourceDetails.field2}{relational operator}{field2 value}...` All the inner fields are traversed using the `.` operator, as shown in the following example: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ``` `resourceDetailsFilter` query supports these relational operators: * `=`—'equal to'. * `!=`—'not equal to'. * `:`—'exists'. This is used for filtering on repeated fields. [`FieldValue`](#fieldvalue) types that are repeated in nature uses `exists` operator for filtering. The following [`FieldValue`](#fieldvalue) types are repeated: * [`TextListValue`](#textlistvalue) * [`SelectionListValue`](#selectionlistvalue) * [`UserListValue`](#userlistvalue) For example, in the following filter, [`SelectionListValue`](#selectionlistvalue), is a repeated field. The filter checks whether [`SelectionListValue`](#selectionlistvalue) contains `selection_id`: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" AND resourceDetails.appliedLabels.fieldValue.type = "SELECTION_LIST_VALUE" AND resourceDetails.appliedLabels.fieldValue.selectionListValue.id: "id" ``` **Usage** ``` GET...&resourceDetailsFilter=resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" GET...&resourceDetailsFilter=resourceDetails.id=%22resourceId%22%20AND%20resourceDetails.appliedLabels.id=%22appliedLabelId%22 ``` **Note the following**: * You must URL encode the query string before sending the request. * The API supports a maximum of 5 fields separated by the AND operator. - When filtering on deeper levels (e.g., [`AppliedLabel`](#appliedlabel), [`FieldValue`](#fieldvalue)), the IDs of all preceding levels in the hierarchy must be included in the filter. For example: Filtering on [`FieldValue`](#fieldvalue) requires [`AppliedLabel`](#appliedlabel) ID and resourceDetails ID to be present. *Sample Query*: ``` resourceDetails.id = "resourceId" AND resourceDetails.appliedLabels.id = "appliedLabelId" AND resourceDetails.appliedLabels.fieldValue.id = "fieldValueId" ``` * Filtering on inner [`FieldValue`](#fieldvalue) types like `longTextValue` and `textValue` requires `resourceDetails.appliedLabels.fieldValue.type` to be present. * Only Filtering on a single [`AppliedLabel`](#appliedlabel) id and [`FieldValue`](#fieldvalue) id is supported.
startTime: string, Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. For Gmail requests, `startTime` and `endTime` must be provided and the difference must not be greater than 30 days.
+ statusFilter: string, Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode="200" GET...&statusFilter=statusCode=%22200%22 ```
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -233,6 +236,12 @@
"resourceIds": [ # Resource ids associated with the event.
"A String",
],
+ "status": { # Status of the event. Note: Not all events have status. # Status of the event. Note: Not all events have status.
+ "errorCode": "A String", # Error code of the event. Note: Field can be empty.
+ "errorMessage": "A String", # Error message of the event. Note: Field can be empty.
+ "eventStatus": "A String", # * Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS - SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED
+ "httpStatusCode": 42, # Status code of the event. Note: Field can be empty.
+ },
"type": "A String", # Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.
},
],
diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html
index af0149f..7ddaef7 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html
@@ -124,12 +124,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
@@ -267,12 +285,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
@@ -410,12 +446,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
@@ -553,12 +607,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
@@ -738,12 +810,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
@@ -881,12 +971,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
@@ -1037,12 +1145,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
@@ -1180,12 +1306,30 @@
"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
{ # Responses from model or agent.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
],
"goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth.
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"text": "A String", # Text response.
"value": "", # Fields and values that can be used to populate the response template.
},
diff --git a/docs/dyn/aiplatform_v1beta1.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.html
new file mode 100644
index 0000000..10a347b
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.html
@@ -0,0 +1,91 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.evaluationMetrics.html">evaluationMetrics</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="aiplatform_v1beta1.evaluationMetrics.operations.html">operations()</a></code>
+</p>
+<p class="firstline">Returns the operations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.evaluationMetrics.operations.html b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.operations.html
new file mode 100644
index 0000000..c6f30a1
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.evaluationMetrics.operations.html
@@ -0,0 +1,212 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.evaluationMetrics.html">evaluationMetrics</a> . <a href="aiplatform_v1beta1.evaluationMetrics.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
+<p class="toc_element">
+ <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next()</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
+ <pre>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+ "A String",
+ ],
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next()</code>
+ <pre>Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html
index ef3684c..257e447 100644
--- a/docs/dyn/aiplatform_v1beta1.html
+++ b/docs/dyn/aiplatform_v1beta1.html
@@ -125,6 +125,11 @@
<p class="firstline">Returns the evaluationItems Resource.</p>
<p class="toc_element">
+ <code><a href="aiplatform_v1beta1.evaluationMetrics.html">evaluationMetrics()</a></code>
+</p>
+<p class="firstline">Returns the evaluationMetrics Resource.</p>
+
+<p class="toc_element">
<code><a href="aiplatform_v1beta1.evaluationRuns.html">evaluationRuns()</a></code>
</p>
<p class="firstline">Returns the evaluationRuns Resource.</p>
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
index cfa8621..06d6ae2 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
@@ -362,6 +362,10 @@
"a_key": "A String",
},
"model": "A String", # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+ "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
"category": "A String", # Required. The harm category to be blocked.
@@ -931,6 +935,10 @@
"a_key": "A String",
},
"model": "A String", # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+ "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+ "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+ },
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
"category": "A String", # Required. The harm category to be blocked.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html
index e857ede..b6acf13 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html
@@ -666,6 +666,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -1286,6 +1295,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -2576,6 +2594,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -3196,6 +3223,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -4486,6 +4522,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -5106,6 +5151,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -6396,6 +6450,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -7016,6 +7079,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -8348,6 +8420,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -8968,6 +9049,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -10258,6 +10348,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -10878,6 +10977,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -12181,6 +12289,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -12801,6 +12918,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -14091,6 +14217,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
@@ -14711,6 +14846,15 @@
],
},
"candidate": "A String", # Required. The name of the candidate that produced the response.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Error while scraping model or agent.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
"events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response.
{ # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
"parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html
new file mode 100644
index 0000000..831f99d
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html
@@ -0,0 +1,91 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.evaluationMetrics.html">evaluationMetrics</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="aiplatform_v1beta1.projects.locations.evaluationMetrics.operations.html">operations()</a></code>
+</p>
+<p class="firstline">Returns the operations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.operations.html
new file mode 100644
index 0000000..228e39e
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.operations.html
@@ -0,0 +1,212 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.evaluationMetrics.html">evaluationMetrics</a> . <a href="aiplatform_v1beta1.projects.locations.evaluationMetrics.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
+<p class="toc_element">
+ <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next()</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
+ <pre>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+ "A String",
+ ],
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next()</code>
+ <pre>Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html
index d37a72f..54f2afa 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html
@@ -130,6 +130,11 @@
<p class="firstline">Returns the evaluationItems Resource.</p>
<p class="toc_element">
+ <code><a href="aiplatform_v1beta1.projects.locations.evaluationMetrics.html">evaluationMetrics()</a></code>
+</p>
+<p class="firstline">Returns the evaluationMetrics Resource.</p>
+
+<p class="toc_element">
<code><a href="aiplatform_v1beta1.projects.locations.evaluationRuns.html">evaluationRuns()</a></code>
</p>
<p class="firstline">Returns the evaluationRuns Resource.</p>
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
index 6692264..414075a 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
@@ -816,6 +816,7 @@
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
+ "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
@@ -1529,6 +1530,7 @@
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
+ "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
@@ -2284,6 +2286,7 @@
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
+ "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
@@ -3011,6 +3014,7 @@
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
+ "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
@@ -3742,6 +3746,7 @@
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
+ "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
@@ -4456,6 +4461,7 @@
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
+ "maxConcurrentActiveRunCount": "A String", # Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html
index 8fb2765..80d47d3 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.devices.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html
@@ -330,11 +330,11 @@
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
- "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6.
+ { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above.
+ "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"carrierName": "A String", # The carrier name associated with this SIM card.
- "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
@@ -762,11 +762,11 @@
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
- "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6.
+ { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above.
+ "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"carrierName": "A String", # The carrier name associated with this SIM card.
- "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
@@ -1062,11 +1062,11 @@
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
- "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6.
+ { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above.
+ "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"carrierName": "A String", # The carrier name associated with this SIM card.
- "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
@@ -1344,11 +1344,11 @@
"imei": "A String", # IMEI number of the GSM device. For example, A1000031212.
"meid": "A String", # MEID number of the CDMA device. For example, A00000292788E1.
"networkOperatorName": "A String", # Alphabetic name of current registered operator. For example, Vodafone.
- "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- { # Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.
- "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "telephonyInfos": [ # Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6.
+ { # Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above.
+ "activationState": "A String", # Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"carrierName": "A String", # The carrier name associated with this SIM card.
- "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.
+ "configMode": "A String", # Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15.
"iccId": "A String", # Output only. The ICCID associated with this SIM card.
"phoneNumber": "A String", # The phone number associated with this SIM card.
},
diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html
index 7c77f46..edbbdac 100644
--- a/docs/dyn/apihub_v1.projects.locations.html
+++ b/docs/dyn/apihub_v1.projects.locations.html
@@ -150,7 +150,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -1057,7 +1057,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/appsmarket_v2.customerLicense.html b/docs/dyn/appsmarket_v2.customerLicense.html
index d87522e..062fd93 100644
--- a/docs/dyn/appsmarket_v2.customerLicense.html
+++ b/docs/dyn/appsmarket_v2.customerLicense.html
@@ -79,7 +79,7 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(applicationId, customerId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the status of a license for a customer to determine if they have access for a given app.</p>
+<p class="firstline">Gets the customer's licensing status to determine if they have access to a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -88,11 +88,11 @@
<div class="method">
<code class="details" id="get">get(applicationId, customerId, x__xgafv=None)</code>
- <pre>Gets the status of a license for a customer to determine if they have access for a given app.
+ <pre>Gets the customer's licensing status to determine if they have access to a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).
Args:
- applicationId: string, Application Id (required)
- customerId: string, Customer Id (required)
+ applicationId: string, The ID of the application. (required)
+ customerId: string, The ID of the customer. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -112,8 +112,8 @@
},
],
"id": "A String", # The ID of the customer license.
- "kind": "A String", # The type of API resource. This is always appsmarket#customerLicense.
- "state": "A String", # The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license: either this customer has never installed your application, or else has deleted it.
+ "kind": "A String", # The type of API resource. This is always `appsmarket#customerLicense`.
+ "state": "A String", # The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license. Either this customer has never installed your application or has deleted it.
}</pre>
</div>
diff --git a/docs/dyn/appsmarket_v2.userLicense.html b/docs/dyn/appsmarket_v2.userLicense.html
index 26d1401..c90e566 100644
--- a/docs/dyn/appsmarket_v2.userLicense.html
+++ b/docs/dyn/appsmarket_v2.userLicense.html
@@ -79,7 +79,7 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(applicationId, userId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the user's licensing status for their permission to use a given app.</p>
+<p class="firstline">Gets the user's licensing status to determine if they have permission to use a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -88,11 +88,11 @@
<div class="method">
<code class="details" id="get">get(applicationId, userId, x__xgafv=None)</code>
- <pre>Gets the user's licensing status for their permission to use a given app.
+ <pre>Gets the user's licensing status to determine if they have permission to use a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).
Args:
- applicationId: string, Application Id (required)
- userId: string, User Id (required)
+ applicationId: string, The ID of the application. (required)
+ userId: string, The ID of the user. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -106,8 +106,8 @@
"customerId": "A String", # The domain name of the user.
"editionId": "A String", # (Deprecated)
"enabled": True or False, # The domain administrator has activated the application for this domain.
- "id": "A String", # The ID of user license.
- "kind": "A String", # The type of API resource. This is always appsmarket#userLicense.
+ "id": "A String", # The ID of the user license.
+ "kind": "A String", # The type of API resource. This is always `appsmarket#userLicense`.
"state": "A String", # The user's licensing status. One of: - `ACTIVE`: The user has a valid license and should be permitted to use the application. - `UNLICENSED`: The administrator of this user's domain never assigned a seat for the application to this user. - `EXPIRED`: The administrator assigned a seat to this user, but the license is expired.
"userId": "A String", # The email address of the user.
}</pre>
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.html b/docs/dyn/artifactregistry_v1.projects.locations.html
index ce72d99..262df33 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.html
@@ -95,7 +95,7 @@
<p class="firstline">Retrieves the VPCSC Config for the Project.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -157,7 +157,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.html
index fadb773..310933b 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.html
+++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.html
@@ -92,7 +92,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -131,7 +131,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.html
index 06ad358..3648a39 100644
--- a/docs/dyn/artifactregistry_v1beta2.projects.locations.html
+++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.html
@@ -92,7 +92,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -131,7 +131,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/biglake_v1.projects.catalogs.html b/docs/dyn/biglake_v1.projects.catalogs.html
index cb5932b..a4c9a01 100644
--- a/docs/dyn/biglake_v1.projects.catalogs.html
+++ b/docs/dyn/biglake_v1.projects.catalogs.html
@@ -88,6 +88,9 @@
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the IAM policy for the specified catalog.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Tests the IAM permissions for the specified catalog.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -227,4 +230,34 @@
}</pre>
</div>
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
+ <pre>Tests the IAM permissions for the specified catalog.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+}</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/biglake_v1.projects.catalogs.namespaces.html b/docs/dyn/biglake_v1.projects.catalogs.namespaces.html
index 76b5d3a..054a2e9 100644
--- a/docs/dyn/biglake_v1.projects.catalogs.namespaces.html
+++ b/docs/dyn/biglake_v1.projects.catalogs.namespaces.html
@@ -75,6 +75,11 @@
<h1><a href="biglake_v1.html">BigLake API</a> . <a href="biglake_v1.projects.html">projects</a> . <a href="biglake_v1.projects.catalogs.html">catalogs</a> . <a href="biglake_v1.projects.catalogs.namespaces.html">namespaces</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="biglake_v1.projects.catalogs.namespaces.tables.html">tables()</a></code>
+</p>
+<p class="firstline">Returns the tables Resource.</p>
+
+<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
@@ -83,6 +88,9 @@
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the IAM policy for the specified catalog.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Tests the IAM permissions for the specified namespace.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -222,4 +230,34 @@
}</pre>
</div>
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
+ <pre>Tests the IAM permissions for the specified namespace.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+}</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/biglake_v1.projects.catalogs.namespaces.tables.html b/docs/dyn/biglake_v1.projects.catalogs.namespaces.tables.html
new file mode 100644
index 0000000..3079e86
--- /dev/null
+++ b/docs/dyn/biglake_v1.projects.catalogs.namespaces.tables.html
@@ -0,0 +1,258 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="biglake_v1.html">BigLake API</a> . <a href="biglake_v1.projects.html">projects</a> . <a href="biglake_v1.projects.catalogs.html">catalogs</a> . <a href="biglake_v1.projects.catalogs.namespaces.html">namespaces</a> . <a href="biglake_v1.projects.catalogs.namespaces.tables.html">tables</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the IAM policy for the specified Catalog.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the IAM policy for the specified catalog.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Tests the IAM permissions for the specified table.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
+ <pre>Gets the IAM policy for the specified Catalog.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
+ <pre>Sets the IAM policy for the specified catalog.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
+ <pre>Tests the IAM permissions for the specified table.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+ "A String",
+ ],
+}</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
index 5a877c9..afb8e54 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
@@ -267,6 +267,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
@@ -473,6 +475,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
@@ -762,6 +766,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
@@ -1043,6 +1049,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
@@ -1240,6 +1248,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
@@ -1365,6 +1375,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
@@ -1530,6 +1542,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
@@ -1736,6 +1750,8 @@
},
"float64Type": { # Float64 Values of type `Float64` are stored in `Value.float_value`. # Float64
},
+ "geographyType": { # A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes. # Geography
+ },
"int64Type": { # Int64 Values of type `Int64` are stored in `Value.int_value`. # Int64
"encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types.
"bigEndianBytes": { # Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` # Use `BigEndianBytes` encoding.
diff --git a/docs/dyn/bigtableadmin_v2.projects.locations.html b/docs/dyn/bigtableadmin_v2.projects.locations.html
index 16b7c63..0597c67 100644
--- a/docs/dyn/bigtableadmin_v2.projects.locations.html
+++ b/docs/dyn/bigtableadmin_v2.projects.locations.html
@@ -79,7 +79,7 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -91,7 +91,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/ces_v1.projects.locations.apps.agents.html b/docs/dyn/ces_v1.projects.locations.apps.agents.html
index c604adc..37984cf 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.agents.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.agents.html
@@ -115,6 +115,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -122,6 +123,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -129,6 +131,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -136,6 +139,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -143,6 +147,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -150,6 +155,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -231,6 +237,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -238,6 +245,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -245,6 +253,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -252,6 +261,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -259,6 +269,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -266,6 +277,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -373,6 +385,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -380,6 +393,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -387,6 +401,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -394,6 +409,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -401,6 +417,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -408,6 +425,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -501,6 +519,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -508,6 +527,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -515,6 +535,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -522,6 +543,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -529,6 +551,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -536,6 +559,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -635,6 +659,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -642,6 +667,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -649,6 +675,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -656,6 +683,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -663,6 +691,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -670,6 +699,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -751,6 +781,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -758,6 +789,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -765,6 +797,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -772,6 +805,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -779,6 +813,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -786,6 +821,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
diff --git a/docs/dyn/ces_v1.projects.locations.apps.conversations.html b/docs/dyn/ces_v1.projects.locations.apps.conversations.html
index 07915a3..baf5ebc 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.conversations.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.conversations.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(name, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of the specified conversation.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, sources=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists conversations in the given app.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
@@ -326,7 +326,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, sources=None, x__xgafv=None)</code>
<pre>Lists conversations in the given app.
Args:
@@ -334,7 +334,13 @@
filter: string, Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.
- source: string, Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.
+ source: string, Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field.
+ Allowed values
+ SOURCE_UNSPECIFIED - Unspecified source.
+ LIVE - The conversation is from the live end user.
+ SIMULATOR - The conversation is from the simulator.
+ EVAL - The conversation is from the evaluation.
+ sources: string, Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. (repeated)
Allowed values
SOURCE_UNSPECIFIED - Unspecified source.
LIVE - The conversation is from the live end user.
diff --git a/docs/dyn/ces_v1.projects.locations.apps.guardrails.html b/docs/dyn/ces_v1.projects.locations.apps.guardrails.html
index a85e685..df8c4ab 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.guardrails.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.guardrails.html
@@ -131,21 +131,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -237,21 +241,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -369,21 +377,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -487,21 +499,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -611,21 +627,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -717,21 +737,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html
index 0b59aba..54bdd8e 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.html
@@ -776,6 +776,7 @@
"appId": "A String", # Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.
"displayName": "A String", # Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.
"gcsUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs:///`.
+ "ignoreAppLock": True or False, # Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.
"importOptions": { # Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data. # Optional. Options governing the import process for the app.
"conflictResolutionStrategy": "A String", # Optional. The strategy to use when resolving conflicts during import.
},
diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html
index 11cb525..e339f54 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.tools.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html
@@ -326,6 +326,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -763,6 +767,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -1226,6 +1234,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -1676,6 +1688,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -2130,6 +2146,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -2567,6 +2587,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html
index fdd3a63..467845e 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html
@@ -1224,6 +1224,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html
index 20cd8f1..7f5f720 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.versions.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html
@@ -124,6 +124,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -131,6 +132,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -138,6 +140,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -145,6 +148,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -152,6 +156,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -159,6 +164,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -525,21 +531,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -818,6 +828,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -1185,6 +1199,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1192,6 +1207,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1199,6 +1215,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1206,6 +1223,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1213,6 +1231,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1220,6 +1239,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1586,21 +1606,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -1879,6 +1903,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -2271,6 +2299,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2278,6 +2307,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2285,6 +2315,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2292,6 +2323,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2299,6 +2331,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2306,6 +2339,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2672,21 +2706,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -2965,6 +3003,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -3344,6 +3386,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3351,6 +3394,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3358,6 +3402,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3365,6 +3410,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3372,6 +3418,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3379,6 +3426,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3745,21 +3793,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -4038,6 +4090,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html
index fdd458a..b29fdb7 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html
@@ -115,6 +115,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -122,6 +123,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -129,6 +131,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -136,6 +139,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -143,6 +147,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -150,6 +155,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -231,6 +237,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -238,6 +245,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -245,6 +253,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -252,6 +261,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -259,6 +269,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -266,6 +277,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -373,6 +385,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -380,6 +393,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -387,6 +401,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -394,6 +409,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -401,6 +417,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -408,6 +425,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -501,6 +519,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -508,6 +527,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -515,6 +535,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -522,6 +543,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -529,6 +551,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -536,6 +559,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -635,6 +659,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -642,6 +667,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -649,6 +675,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -656,6 +683,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -663,6 +691,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -670,6 +699,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -751,6 +781,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -758,6 +789,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -765,6 +797,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -772,6 +805,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -779,6 +813,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -786,6 +821,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html
index 2b60b36..6d10117 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html
@@ -90,7 +90,7 @@
<code><a href="#get">get(name, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of the specified conversation.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, sources=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists conversations in the given app.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
@@ -371,7 +371,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, source=None, sources=None, x__xgafv=None)</code>
<pre>Lists conversations in the given app.
Args:
@@ -379,7 +379,13 @@
filter: string, Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.
- source: string, Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.
+ source: string, Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field.
+ Allowed values
+ SOURCE_UNSPECIFIED - Unspecified source.
+ LIVE - The conversation is from the live end user.
+ SIMULATOR - The conversation is from the simulator.
+ EVAL - The conversation is from the evaluation.
+ sources: string, Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. (repeated)
Allowed values
SOURCE_UNSPECIFIED - Unspecified source.
LIVE - The conversation is from the live end user.
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.guardrails.html b/docs/dyn/ces_v1beta.projects.locations.apps.guardrails.html
index 1cf344a..04d14ad 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.guardrails.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.guardrails.html
@@ -131,21 +131,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -237,21 +241,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -369,21 +377,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -487,21 +499,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -611,21 +627,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -717,21 +737,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html
index 8f995d0..b49460b 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.html
@@ -848,6 +848,7 @@
"appId": "A String", # Optional. The ID to use for the imported app. * If not specified, a unique ID will be automatically assigned for the app. * Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced.
"displayName": "A String", # Optional. The display name of the app to import. * If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. * If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error.
"gcsUri": "A String", # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs:///`.
+ "ignoreAppLock": True or False, # Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.
"importOptions": { # Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data. # Optional. Options governing the import process for the app.
"conflictResolutionStrategy": "A String", # Optional. The strategy to use when resolving conflicts during import.
},
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
index 5c7cf02..3a5fe99 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
@@ -326,6 +326,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -763,6 +767,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -1226,6 +1234,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -1676,6 +1688,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -2130,6 +2146,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -2567,6 +2587,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html
index 7311e27..cd8a744 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html
@@ -1224,6 +1224,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html
index 7343d6a..9cf3af3 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html
@@ -124,6 +124,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -131,6 +132,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -138,6 +140,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -145,6 +148,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -152,6 +156,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -159,6 +164,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -544,21 +550,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -837,6 +847,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -1204,6 +1218,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1211,6 +1226,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1218,6 +1234,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1225,6 +1242,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1232,6 +1250,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1239,6 +1258,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -1624,21 +1644,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -1917,6 +1941,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -2309,6 +2337,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2316,6 +2345,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2323,6 +2353,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2330,6 +2361,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2337,6 +2369,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2344,6 +2377,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -2729,21 +2763,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -3022,6 +3060,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
@@ -3401,6 +3443,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3408,6 +3451,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3415,6 +3459,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3422,6 +3467,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3429,6 +3475,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3436,6 +3483,7 @@
{ # A callback defines the custom logic to be executed at various stages of agent interaction.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
],
@@ -3821,21 +3869,25 @@
"afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
"beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
"description": "A String", # Optional. Human-readable description of the callback.
"disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
"pythonCode": "A String", # Required. The python code to execute for the callback.
},
},
@@ -4114,6 +4166,10 @@
"preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
"A String",
],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
},
"mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
"apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index 79444d9..73def8d 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -452,8 +452,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -802,8 +803,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -1314,8 +1316,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -1664,8 +1667,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -2389,8 +2393,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -2739,8 +2744,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -3482,8 +3488,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -3832,8 +3839,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -4344,8 +4352,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -4694,8 +4703,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -5419,8 +5429,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -5769,8 +5780,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -6530,8 +6542,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -6880,8 +6893,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -7392,8 +7406,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -7742,8 +7757,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -8467,8 +8483,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -8817,8 +8834,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -9566,8 +9584,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -9916,8 +9935,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -10428,8 +10448,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -10778,8 +10799,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -11503,8 +11525,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -11853,8 +11876,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -12607,8 +12631,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -12957,8 +12982,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -13469,8 +13495,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -13819,8 +13846,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -14544,8 +14572,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -14894,8 +14923,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -15631,8 +15661,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -15981,8 +16012,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -16493,8 +16525,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -16843,8 +16876,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -17568,8 +17602,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -17918,8 +17953,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -18655,8 +18691,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -19005,8 +19042,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -19517,8 +19555,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -19867,8 +19906,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -20592,8 +20632,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -20942,8 +20983,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -21679,8 +21721,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -22029,8 +22072,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -22541,8 +22585,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -22891,8 +22936,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -23616,8 +23662,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -23966,8 +24013,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html
index 1908765..00891b0 100644
--- a/docs/dyn/chat_v1.spaces.spaceEvents.html
+++ b/docs/dyn/chat_v1.spaces.spaceEvents.html
@@ -567,8 +567,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -917,8 +918,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -1429,8 +1431,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -1779,8 +1782,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -2504,8 +2508,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -2854,8 +2859,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -3586,8 +3592,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -3936,8 +3943,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -4448,8 +4456,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -4798,8 +4807,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -5523,8 +5533,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -5873,8 +5884,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -6605,8 +6617,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -6955,8 +6968,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -7467,8 +7481,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -7817,8 +7832,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -8542,8 +8558,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -8892,8 +8909,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -9622,8 +9640,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -9972,8 +9991,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -10484,8 +10504,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -10834,8 +10855,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -11559,8 +11581,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -11909,8 +11932,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -12637,8 +12661,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -12987,8 +13012,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -13499,8 +13525,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -13849,8 +13876,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -14574,8 +14602,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -14924,8 +14953,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -15652,8 +15682,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -16002,8 +16033,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -16514,8 +16546,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -16864,8 +16897,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -17589,8 +17623,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -17939,8 +17974,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -19084,8 +19120,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -19434,8 +19471,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -19946,8 +19984,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -20296,8 +20335,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -21021,8 +21061,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -21371,8 +21412,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -22103,8 +22145,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -22453,8 +22496,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -22965,8 +23009,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -23315,8 +23360,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -24040,8 +24086,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -24390,8 +24437,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -25122,8 +25170,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -25472,8 +25521,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -25984,8 +26034,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -26334,8 +26385,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -27059,8 +27111,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -27409,8 +27462,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -28139,8 +28193,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -28489,8 +28544,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -29001,8 +29057,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -29351,8 +29408,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -30076,8 +30134,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -30426,8 +30485,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -31154,8 +31214,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -31504,8 +31565,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -32016,8 +32078,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -32366,8 +32429,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -33091,8 +33155,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -33441,8 +33506,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -34169,8 +34235,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -34519,8 +34586,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -35031,8 +35099,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -35381,8 +35450,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -36106,8 +36176,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget.
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
@@ -36456,8 +36527,9 @@
"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action.
},
"selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ```
- "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
+ "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.
{ # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.
+ "minCharactersTrigger": 42, # The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).
"platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application.
"commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.
"hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries).
diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html
index 79308f2..306308e 100644
--- a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html
+++ b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html
@@ -354,6 +354,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
@@ -475,6 +485,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
@@ -781,6 +801,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
@@ -902,6 +932,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
@@ -1098,6 +1138,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
@@ -1219,6 +1269,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
@@ -1376,6 +1436,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
@@ -1497,6 +1567,16 @@
"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
"availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
"binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
+ "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.
+ "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.
+ { # The Direct VPC network interface. This is mutually exclusive with VPC Connector.
+ "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.
+ "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+ "tags": [ # Optional. Network tags applied to this Cloud Function resource.
+ "A String",
+ ],
+ },
+ ],
"environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html
index cb015ba..59f6efd 100644
--- a/docs/dyn/cloudkms_v1.folders.html
+++ b/docs/dyn/cloudkms_v1.folders.html
@@ -113,7 +113,7 @@
"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
"keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
"keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
- "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+ "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}</pre>
</div>
@@ -147,7 +147,7 @@
<pre>Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
Args:
- name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` (required)
+ name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
body: object, The request body.
The object takes the form of:
@@ -155,7 +155,7 @@
"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
"keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
"keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
- "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+ "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}
@@ -172,7 +172,7 @@
"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
"keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
"keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
- "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+ "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}</pre>
</div>
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html
index e307ac1..1b177bf 100644
--- a/docs/dyn/cloudkms_v1.projects.html
+++ b/docs/dyn/cloudkms_v1.projects.html
@@ -127,7 +127,7 @@
"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
"keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
"keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
- "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+ "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}</pre>
</div>
@@ -236,7 +236,7 @@
<pre>Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
Args:
- name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` (required)
+ name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
body: object, The request body.
The object takes the form of:
@@ -244,7 +244,7 @@
"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
"keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
"keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
- "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+ "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}
@@ -261,7 +261,7 @@
"etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
"keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
"keyProjectResolutionMode": "A String", # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
- "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+ "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}</pre>
</div>
diff --git a/docs/dyn/cloudkms_v1.projects.locations.html b/docs/dyn/cloudkms_v1.projects.locations.html
index d315597..7203e14 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.html
@@ -100,6 +100,11 @@
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
+ <code><a href="cloudkms_v1.projects.locations.retiredResources.html">retiredResources()</a></code>
+</p>
+<p class="firstline">Returns the retiredResources Resource.</p>
+
+<p class="toc_element">
<code><a href="cloudkms_v1.projects.locations.singleTenantHsmInstances.html">singleTenantHsmInstances()</a></code>
</p>
<p class="firstline">Returns the singleTenantHsmInstances Resource.</p>
@@ -118,7 +123,7 @@
<p class="firstline">Returns the EkmConfig singleton resource for a given project and location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -208,7 +213,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
index da8d98b..651b184 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
@@ -90,6 +90,9 @@
<code><a href="#decapsulate">decapsulate(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.</p>
<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Permanently deletes the given CryptoKeyVersion. Only possible if the version has not been previously imported and if its state is one of DESTROYED, IMPORT_FAILED, or GENERATION_FAILED. Successfully imported CryptoKeyVersions cannot be deleted at this time. The specified version will be immediately and permanently deleted upon calling this method. This action cannot be undone.</p>
+<p class="toc_element">
<code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.</p>
<p class="toc_element">
@@ -321,6 +324,41 @@
</div>
<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Permanently deletes the given CryptoKeyVersion. Only possible if the version has not been previously imported and if its state is one of DESTROYED, IMPORT_FAILED, or GENERATION_FAILED. Successfully imported CryptoKeyVersions cannot be deleted at this time. The specified version will be immediately and permanently deleted upon calling this method. This action cannot be undone.
+
+Args:
+ name: string, Required. The name of the CryptoKeyVersion to delete. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>
<pre>Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
index 0ca723d..e4a7f95 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
@@ -89,6 +89,9 @@
<code><a href="#decrypt">decrypt(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.</p>
<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Permanently deletes the given CryptoKey. All child CryptoKeyVersions must have been previously deleted using KeyManagementService.DeleteCryptoKeyVersion. The specified crypto key will be immediately and permanently deleted upon calling this method. This action cannot be undone.</p>
+<p class="toc_element">
<code><a href="#encrypt">encrypt(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.</p>
<p class="toc_element">
@@ -290,6 +293,41 @@
</div>
<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Permanently deletes the given CryptoKey. All child CryptoKeyVersions must have been previously deleted using KeyManagementService.DeleteCryptoKeyVersion. The specified crypto key will be immediately and permanently deleted upon calling this method. This action cannot be undone.
+
+Args:
+ name: string, Required. The name of the CryptoKey to delete. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="encrypt">encrypt(name, body=None, x__xgafv=None)</code>
<pre>Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
diff --git a/docs/dyn/cloudkms_v1.projects.locations.retiredResources.html b/docs/dyn/cloudkms_v1.projects.locations.retiredResources.html
new file mode 100644
index 0000000..a9506b1
--- /dev/null
+++ b/docs/dyn/cloudkms_v1.projects.locations.retiredResources.html
@@ -0,0 +1,161 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a> . <a href="cloudkms_v1.projects.locations.html">locations</a> . <a href="cloudkms_v1.projects.locations.retiredResources.html">retiredResources</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next()</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey.
+
+Args:
+ name: string, Required. The name of the RetiredResource to get. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A RetiredResource resource represents the record of a deleted CryptoKey. Its purpose is to provide visibility into retained user data and to prevent reuse of these names for new CryptoKeys.
+ "deleteTime": "A String", # Output only. The time at which the original resource was deleted and this RetiredResource record was created.
+ "name": "A String", # Output only. Identifier. The resource name for this RetiredResource in the format `projects/*/locations/*/retiredResources/*`.
+ "originalResource": "A String", # Output only. The full resource name of the original CryptoKey that was deleted in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+ "resourceType": "A String", # Output only. The resource type of the original deleted resource.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion.
+
+Args:
+ parent: string, Required. The project-specific location holding the RetiredResources, in the format `projects/*/locations/*`. (required)
+ pageSize: integer, Optional. Optional limit on the number of RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Optional pagination token, returned earlier via ListRetiredResourcesResponse.next_page_token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for KeyManagementService.ListRetiredResources.
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in ListRetiredResourcesRequest.page_token to retrieve the next page of results.
+ "retiredResources": [ # The list of RetiredResources.
+ { # A RetiredResource resource represents the record of a deleted CryptoKey. Its purpose is to provide visibility into retained user data and to prevent reuse of these names for new CryptoKeys.
+ "deleteTime": "A String", # Output only. The time at which the original resource was deleted and this RetiredResource record was created.
+ "name": "A String", # Output only. Identifier. The resource name for this RetiredResource in the format `projects/*/locations/*/retiredResources/*`.
+ "originalResource": "A String", # Output only. The full resource name of the original CryptoKey that was deleted in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+ "resourceType": "A String", # Output only. The resource type of the original deleted resource.
+ },
+ ],
+ "totalSize": "A String", # The total number of RetiredResources that matched the query.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next()</code>
+ <pre>Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.addresses.html b/docs/dyn/compute_alpha.addresses.html
index 6e95939..4f69ae0 100644
--- a/docs/dyn/compute_alpha.addresses.html
+++ b/docs/dyn/compute_alpha.addresses.html
@@ -583,6 +583,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1111,6 +1123,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1674,6 +1698,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1972,6 +2008,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html
index a6e4222..8b53667 100644
--- a/docs/dyn/compute_alpha.advice.html
+++ b/docs/dyn/compute_alpha.advice.html
@@ -249,6 +249,8 @@
},
"instanceProperties": { # Instance provisining properties. # Instance properties for this request.
"scheduling": { # Defines the instance scheduling options. # Specifies the scheduling options.
+ "maxRunDuration": "A String", # The maximum time that instances can run before Compute Engine
+ # terminates them.
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
},
},
@@ -271,6 +273,8 @@
"estimatedUptime": "A String", # The estimated run time of the majority of Spot VMs in the request
# before preemption. The estimate is best-effort only. It is based on
# history data and current conditions.
+ "estimatedWaitDuration": "A String", # Output only. The likely maximum time that you will have to wait until
+ # Compute Engine provisions your instances.
"obtainability": 3.14, # The obtainability score indicates the likelihood of successfully
# obtaining (provisioning) the requested number of VMs.
# The score range is 0.0 through 1.0. Higher is better.
diff --git a/docs/dyn/compute_alpha.autoscalers.html b/docs/dyn/compute_alpha.autoscalers.html
index ce1391a..0869620 100644
--- a/docs/dyn/compute_alpha.autoscalers.html
+++ b/docs/dyn/compute_alpha.autoscalers.html
@@ -831,6 +831,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1853,6 +1865,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3013,6 +3037,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3693,6 +3729,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.backendBuckets.html b/docs/dyn/compute_alpha.backendBuckets.html
index 05a9e5f..2270b44 100644
--- a/docs/dyn/compute_alpha.backendBuckets.html
+++ b/docs/dyn/compute_alpha.backendBuckets.html
@@ -306,6 +306,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -977,6 +989,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1261,6 +1285,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2315,6 +2351,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3481,6 +3529,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3770,6 +3830,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5155,6 +5227,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html
index 8ca3bc2..b23e40f 100644
--- a/docs/dyn/compute_alpha.backendServices.html
+++ b/docs/dyn/compute_alpha.backendServices.html
@@ -315,6 +315,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -686,6 +698,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -1540,6 +1556,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -2548,6 +2569,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2832,6 +2865,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3103,6 +3148,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -3957,6 +4006,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -6066,6 +6120,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -6920,6 +6978,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -7836,6 +7899,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -8193,6 +8268,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -9047,6 +9126,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -10080,6 +10164,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -10934,6 +11022,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -11910,6 +12003,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -12764,6 +12861,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -13680,6 +13782,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -13969,6 +14083,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -15134,6 +15260,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -15435,6 +15573,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -16289,6 +16431,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -17205,6 +17352,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.crossSiteNetworks.html b/docs/dyn/compute_alpha.crossSiteNetworks.html
index 024fc0d..3e571ac 100644
--- a/docs/dyn/compute_alpha.crossSiteNetworks.html
+++ b/docs/dyn/compute_alpha.crossSiteNetworks.html
@@ -263,6 +263,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -607,6 +619,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1093,6 +1117,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.diskSettings.html b/docs/dyn/compute_alpha.diskSettings.html
index 2d69a2f..a8c78a9 100644
--- a/docs/dyn/compute_alpha.diskSettings.html
+++ b/docs/dyn/compute_alpha.diskSettings.html
@@ -378,6 +378,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
index 235f614..e421082 100644
--- a/docs/dyn/compute_alpha.disks.html
+++ b/docs/dyn/compute_alpha.disks.html
@@ -93,6 +93,9 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
+ <code><a href="#convert">convert(project, zone, disk, body=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Converts a persistent disk to support Gen4+ VMs.</p>
+<p class="toc_element">
<code><a href="#createSnapshot">createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a snapshot of a specified persistent disk. For regular snapshot</p>
<p class="toc_element">
@@ -324,6 +327,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1464,6 +1479,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1766,6 +1793,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1892,6 +1931,314 @@
</div>
<div class="method">
+ <code class="details" id="convert">convert(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Converts a persistent disk to support Gen4+ VMs.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the Disk resource, should conform to RFC1035. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "params": {
+ "forceStopInProgressSnapshot": True or False,
+ "provisionedIops": "A String",
+ "provisionedThroughput": "A String",
+ "quickConversionOnly": True or False,
+ "resetSupportedVmFamilies": True or False,
+ "targetDiskType": "A String",
+ },
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)</code>
<pre>Creates a snapshot of a specified persistent disk. For regular snapshot
creation, consider using snapshots.insert
@@ -2393,6 +2740,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2679,6 +3038,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4657,6 +5028,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5717,6 +6100,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6007,6 +6402,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7180,6 +7587,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7491,6 +7910,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7774,6 +8205,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -8077,6 +8520,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -9017,6 +9472,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -9300,6 +9767,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -9590,6 +10069,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.externalVpnGateways.html b/docs/dyn/compute_alpha.externalVpnGateways.html
index 0f6267d..1c1ef18 100644
--- a/docs/dyn/compute_alpha.externalVpnGateways.html
+++ b/docs/dyn/compute_alpha.externalVpnGateways.html
@@ -265,6 +265,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -740,6 +752,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1266,6 +1290,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.firewallPolicies.html b/docs/dyn/compute_alpha.firewallPolicies.html
index 3406236..cbeca45 100644
--- a/docs/dyn/compute_alpha.firewallPolicies.html
+++ b/docs/dyn/compute_alpha.firewallPolicies.html
@@ -331,6 +331,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -800,6 +812,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1269,6 +1293,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1550,6 +1586,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1835,6 +1883,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2103,6 +2163,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4224,6 +4296,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5207,6 +5291,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5999,6 +6095,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6469,6 +6577,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6939,6 +7059,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7220,6 +7352,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7501,6 +7645,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7782,6 +7938,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.firewalls.html b/docs/dyn/compute_alpha.firewalls.html
index d84f076..1d3bee7 100644
--- a/docs/dyn/compute_alpha.firewalls.html
+++ b/docs/dyn/compute_alpha.firewalls.html
@@ -268,6 +268,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -908,6 +920,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1686,6 +1710,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2176,6 +2212,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html
index 9ca6e73..984b459 100644
--- a/docs/dyn/compute_alpha.forwardingRules.html
+++ b/docs/dyn/compute_alpha.forwardingRules.html
@@ -883,6 +883,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2012,6 +2024,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3274,6 +3298,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3573,6 +3609,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3863,6 +3911,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.futureReservations.html b/docs/dyn/compute_alpha.futureReservations.html
index 34c81b0..18cd25c 100644
--- a/docs/dyn/compute_alpha.futureReservations.html
+++ b/docs/dyn/compute_alpha.futureReservations.html
@@ -221,6 +221,11 @@
"a_key": { # Name of the scope containing this set of future reservations.
"futureReservations": [ # A list of future reservations contained in this scope.
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -288,6 +293,7 @@
# parent commitments will be extended to match the end date of the plan for
# this commitment.
},
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339
# text format.
"deploymentType": "A String", # Type of the deployment requested as part of future reservation.
@@ -352,7 +358,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -451,7 +457,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -789,6 +795,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1076,6 +1094,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1213,6 +1243,11 @@
An object of the form:
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -1280,6 +1315,7 @@
# parent commitments will be extended to match the end date of the plan for
# this commitment.
},
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339
# text format.
"deploymentType": "A String", # Type of the deployment requested as part of future reservation.
@@ -1344,7 +1380,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1443,7 +1479,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1550,6 +1586,11 @@
The object takes the form of:
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -1617,6 +1658,7 @@
# parent commitments will be extended to match the end date of the plan for
# this commitment.
},
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339
# text format.
"deploymentType": "A String", # Type of the deployment requested as part of future reservation.
@@ -1681,7 +1723,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1780,7 +1822,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2029,6 +2071,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2254,6 +2308,11 @@
# defined by the server.
"items": [ # [Output Only] A list of future reservation resources.
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -2321,6 +2380,7 @@
# parent commitments will be extended to match the end date of the plan for
# this commitment.
},
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339
# text format.
"deploymentType": "A String", # Type of the deployment requested as part of future reservation.
@@ -2385,7 +2445,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2484,7 +2544,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2644,6 +2704,11 @@
The object takes the form of:
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -2711,6 +2776,7 @@
# parent commitments will be extended to match the end date of the plan for
# this commitment.
},
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this future reservation inRFC3339
# text format.
"deploymentType": "A String", # Type of the deployment requested as part of future reservation.
@@ -2775,7 +2841,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2874,7 +2940,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -3125,6 +3191,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.globalAddresses.html b/docs/dyn/compute_alpha.globalAddresses.html
index fe49538..ad6cabf 100644
--- a/docs/dyn/compute_alpha.globalAddresses.html
+++ b/docs/dyn/compute_alpha.globalAddresses.html
@@ -271,6 +271,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -817,6 +829,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1377,6 +1401,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1664,6 +1700,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.globalFolderOperations.html b/docs/dyn/compute_alpha.globalFolderOperations.html
index dd90493..7e36eac 100644
--- a/docs/dyn/compute_alpha.globalFolderOperations.html
+++ b/docs/dyn/compute_alpha.globalFolderOperations.html
@@ -240,6 +240,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -595,6 +607,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.globalForwardingRules.html b/docs/dyn/compute_alpha.globalForwardingRules.html
index 3c824a0..360a6a9 100644
--- a/docs/dyn/compute_alpha.globalForwardingRules.html
+++ b/docs/dyn/compute_alpha.globalForwardingRules.html
@@ -271,6 +271,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1399,6 +1411,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2659,6 +2683,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2947,6 +2983,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3236,6 +3284,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html
index 647771f..e062f0c 100644
--- a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html
+++ b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html
@@ -311,6 +311,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -599,6 +611,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -925,6 +949,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1065,6 +1101,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1271,6 +1321,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
body: object, The request body.
@@ -1281,6 +1345,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1635,6 +1713,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1861,6 +1951,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_alpha.globalOperations.html b/docs/dyn/compute_alpha.globalOperations.html
index 1a00d6a..da80997 100644
--- a/docs/dyn/compute_alpha.globalOperations.html
+++ b/docs/dyn/compute_alpha.globalOperations.html
@@ -347,6 +347,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -717,6 +729,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1072,6 +1096,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1406,6 +1442,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.globalOrganizationOperations.html b/docs/dyn/compute_alpha.globalOrganizationOperations.html
index 9473168..22dfcf8 100644
--- a/docs/dyn/compute_alpha.globalOrganizationOperations.html
+++ b/docs/dyn/compute_alpha.globalOrganizationOperations.html
@@ -260,6 +260,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -615,6 +627,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html
index dd06820..de8c369 100644
--- a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html
+++ b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html
@@ -262,6 +262,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -780,6 +792,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1435,6 +1459,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
index 2c45ea9..030a082 100644
--- a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
+++ b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
@@ -573,6 +573,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1109,6 +1121,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1927,6 +1951,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.haControllers.html b/docs/dyn/compute_alpha.haControllers.html
index 5659278..bd401c9 100644
--- a/docs/dyn/compute_alpha.haControllers.html
+++ b/docs/dyn/compute_alpha.haControllers.html
@@ -220,7 +220,10 @@
"haControllers": [ # List of HaControllers contained in this scope.
{ # HaController handles failover for a VM Instance.
"backendServices": [ # Advanced configuration option. If specified, these Backend Services need to
- # be pre-created and configured as managed.
+ # be pre-created.
+ #
+ # Currently, only one backend service can be specified, and it must be L4
+ # Internal Load Balancer (ILB).
"A String",
],
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
@@ -889,6 +892,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1171,6 +1186,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1309,7 +1336,10 @@
{ # HaController handles failover for a VM Instance.
"backendServices": [ # Advanced configuration option. If specified, these Backend Services need to
- # be pre-created and configured as managed.
+ # be pre-created.
+ #
+ # Currently, only one backend service can be specified, and it must be L4
+ # Internal Load Balancer (ILB).
"A String",
],
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
@@ -1753,7 +1783,10 @@
{ # HaController handles failover for a VM Instance.
"backendServices": [ # Advanced configuration option. If specified, these Backend Services need to
- # be pre-created and configured as managed.
+ # be pre-created.
+ #
+ # Currently, only one backend service can be specified, and it must be L4
+ # Internal Load Balancer (ILB).
"A String",
],
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
@@ -2328,6 +2361,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2552,7 +2597,10 @@
"items": [ # A list of HaControllers in the specified project and region.
{ # HaController handles failover for a VM Instance.
"backendServices": [ # Advanced configuration option. If specified, these Backend Services need to
- # be pre-created and configured as managed.
+ # be pre-created.
+ #
+ # Currently, only one backend service can be specified, and it must be L4
+ # Internal Load Balancer (ILB).
"A String",
],
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
@@ -3046,7 +3094,10 @@
{ # HaController handles failover for a VM Instance.
"backendServices": [ # Advanced configuration option. If specified, these Backend Services need to
- # be pre-created and configured as managed.
+ # be pre-created.
+ #
+ # Currently, only one backend service can be specified, and it must be L4
+ # Internal Load Balancer (ILB).
"A String",
],
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
@@ -3622,6 +3673,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.healthChecks.html b/docs/dyn/compute_alpha.healthChecks.html
index 4b6749e..a267673 100644
--- a/docs/dyn/compute_alpha.healthChecks.html
+++ b/docs/dyn/compute_alpha.healthChecks.html
@@ -830,6 +830,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1852,6 +1864,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3011,6 +3035,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3690,6 +3726,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.httpHealthChecks.html b/docs/dyn/compute_alpha.httpHealthChecks.html
index 1419c95..d4e2fe3 100644
--- a/docs/dyn/compute_alpha.httpHealthChecks.html
+++ b/docs/dyn/compute_alpha.httpHealthChecks.html
@@ -268,6 +268,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -648,6 +660,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1165,6 +1189,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1523,6 +1559,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.httpsHealthChecks.html b/docs/dyn/compute_alpha.httpsHealthChecks.html
index f872e6c..2bf1016 100644
--- a/docs/dyn/compute_alpha.httpsHealthChecks.html
+++ b/docs/dyn/compute_alpha.httpsHealthChecks.html
@@ -268,6 +268,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -656,6 +668,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1181,6 +1205,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1543,6 +1579,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html
index fc89928..1e8a9ce 100644
--- a/docs/dyn/compute_alpha.images.html
+++ b/docs/dyn/compute_alpha.images.html
@@ -280,6 +280,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -609,6 +621,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2923,6 +2947,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4449,6 +4485,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5610,6 +5658,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html
index 7a1d1d8..491f0b4 100644
--- a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html
+++ b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html
@@ -265,6 +265,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -558,6 +570,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1593,6 +1617,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html
index 9c15c75..35f7fd4 100644
--- a/docs/dyn/compute_alpha.instanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.instanceGroupManagers.html
@@ -90,6 +90,9 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
+ <code><a href="#configureAcceleratorTopologies">configureAcceleratorTopologies(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the accelerator topologies configuration.</p>
+<p class="toc_element">
<code><a href="#createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates instances with per-instance configurations in this managed instance</p>
<p class="toc_element">
@@ -367,6 +370,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -742,6 +757,8 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
"starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
@@ -2286,6 +2303,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -2543,6 +2561,7 @@
"allInstances": True or False, # Flag to update all instances instead of specified list of “instances”.
# If the flag is set to true then the instances may not be specified
# in the request.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instances": [ # The list of URLs of one or more instances for which you want to apply
# updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].
"A String",
@@ -2725,6 +2744,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2851,6 +2882,313 @@
</div>
<div class="method">
+ <code class="details" id="configureAcceleratorTopologies">configureAcceleratorTopologies(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Updates the accelerator topologies configuration.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone
+where the managed instance group is located.
+It should conform to RFC1035. (required)
+ instanceGroupManager: string, The name of the managed instance group.
+It should conform to RFC1035. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # InstanceGroupManagers.ConfigureAcceleratorTopologies
+ "acceleratorTopologyActions": { # Map of accelerator topologies that should have their state changed to
+ # the specified value. The key is the hashed topology locus id. It can be
+ # obtained from the GetAvailableAcceleratorTopologies rpc.
+ "a_key": "A String",
+ },
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
<pre>Creates instances with per-instance configurations in this managed instance
group. Instances are created using the current instance template. Thecreate instances operation is marked DONE if thecreateInstances request is successful. The underlying actions
@@ -3091,6 +3429,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3377,6 +3727,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3698,6 +4060,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3982,6 +4356,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4258,6 +4644,8 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
"starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
@@ -5802,6 +6190,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -5987,8 +6376,113 @@
"a_key": {
"acceleratorTopology": "A String", # Topology in the format of: "16x16", "4x4x4", etc.
"acceleratorTopologyHealth": "A String",
+ "acceleratorTopologyState": { # Specifies the topology state
+ "currentState": "A String",
+ "error": { # Reason why the topology state change failed
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "errorTimestamp": "A String", # Timestamp when the last error happened
+ },
+ "instancesHealth": "A String",
+ "parent": "A String", # Identified by the topology Id in the accelerator_topology_info map. Empty
+ # for the top-level topology
},
},
+ "multiMig": "A String", # URL to MMIG this MIG belongs to.
}</pre>
</div>
@@ -6152,6 +6646,8 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
"starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
@@ -7696,6 +8192,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -8009,6 +8506,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -8371,6 +8880,8 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
"starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
@@ -9915,6 +10426,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -12088,5682 +12600,7 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
- "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be resumed or are currently being resumed.
- "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be started or are currently being started.
- "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be stopped or are currently being stopped.
- "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be suspended or are currently being suspended.
- "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are being verified. See the managedInstances[].currentAction
- # property in the listManagedInstances method documentation.
- },
- "description": "A String", # An optional description of this resource.
- "distributionPolicy": { # Policy specifying the intended distribution of managed instances across
- # zones in a regional managed instance group.
- "targetShape": "A String", # The distribution shape to which the group converges either proactively or
- # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
- "zones": [ # Zones where the regional managed instance group will create and manage
- # its instances.
- {
- "zone": "A String", # The URL of thezone.
- # The zone must exist in the region where the managed instance group is
- # located.
- },
- ],
- },
- "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER.
- "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking.
- # It will be ignored when inserting an InstanceGroupManager. An up-to-date
- # fingerprint must be provided in order to update the InstanceGroupManager,
- # otherwise the request will fail with error412 conditionNotMet.
- #
- # To see the latest fingerprint, make a get() request to
- # retrieve an InstanceGroupManager.
- "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
- # generates this identifier.
- "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple
- # types of machines.
- # Instance flexibility configuration on MIG overrides instance
- # template configuration.
- "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
- # when creating new VMs.
- "a_key": {
- "disks": [ # List of disks to be attached to the instances created from this
- # selection.
- { # An instance-attached disk resource.
- "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
- # or X86_64.
- "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
- # deleted (but not when the disk is detached from the instance).
- "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
- # partition of the disk for its root filesystem.
- "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
- # running within the instance. This name can be used to reference the device
- # for mounting, resizing, and so on, from within the instance.
- #
- # If not specified, the server chooses a default device name to apply to this
- # disk, in the form persistent-disk-x, where x is a number
- # assigned by Google Compute Engine. This field is only applicable for
- # persistent disks.
- "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
- # encryption key.
- #
- # If you are creating a new disk, this field encrypts the new disk using
- # an encryption key that you provide. If you are attaching an existing
- # disk that is already encrypted, this field decrypts the disk using
- # the customer-supplied encryption key.
- #
- # If you encrypt a disk using a customer-supplied key, you must provide the
- # same key again when you attempt to use this resource at a later time. For
- # example, you must provide the key when you create a snapshot or an image
- # from the disk or when you attach the disk to a virtual machine instance.
- #
- # If you do not provide an encryption key, then the disk will be encrypted
- # using an automatically generated key and you do not need to provide a key
- # to use the disk later.
- #
- # Note:
- #
- # Instance templates do not storecustomer-supplied
- # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
- #
- # You cannot create VMs that have disks with customer-supplied keys using
- # the bulk
- # insert method.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "diskSizeGb": "A String", # The size of the disk in GB.
- "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
- # currently attached to another instance. If you try to force attach a zonal
- # disk to an instance, you will receive an error.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
- # boot disk. If you have many disks attached to an instance, each
- # disk would have a unique index number.
- "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This field is persisted and returned for instanceTemplate and not returned
- # in the context of instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- "architecture": "A String", # The architecture of the attached disk. Valid values are
- # arm64 or x86_64.
- "description": "A String", # An optional description. Provide this property when creating the disk.
- "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
- # of the instance. If a disk with the same name already exists in the given
- # region, the existing disk is attached to the new instance and the
- # new disk is not created.
- "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
- # 10 GB. If you specify a sourceImage, which is required for
- # boot disks, the default size is the size of the sourceImage.
- # If you do not specify a sourceImage, the default disk size
- # is 500 GB.
- "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
- # the default is pd-standard, specified using the full URL.
- # For example:
- #
- # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
- #
- #
- # For a full list of acceptable values, seePersistent disk
- # types. If you specify this field when creating a VM, you can provide
- # either the full or partial URL. For example, the following values are
- # valid:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
- # - projects/project/zones/zone/diskTypes/diskType
- # - zones/zone/diskTypes/diskType
- #
- #
- # If you specify this field when creating or updating an instance template
- # or all-instances configuration, specify the type of the disk, not the
- # URL. For example: pd-standard.
- "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- #
- # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
- # which is either SCSI or NVME. The default isSCSI.
- "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
- # persistent disks.
- "a_key": "A String",
- },
- "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
- # disk.
- "A String",
- ],
- "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
- "A String",
- ],
- "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
- # more than one instance.
- "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
- # is to use the existing disk.
- "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
- # of I/O operations per second that the disk can handle. Values must be
- # between 10,000 and 120,000. For more details, see theExtreme persistent
- # disk documentation.
- "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
- # number of throughput mb per second that the disk can handle. Values must
- # greater than or equal to 1.
- "replicaZones": [ # Required for each regional disk associated with the instance. Specify
- # the URLs of the zones where the disk should be replicated to.
- # You must provide exactly two replica zones, and one zone must be the same
- # as the instance zone.
- "A String",
- ],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
- # have the same definition as resource
- # manager tags. Keys and values can be either in numeric format,
- # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
- # format such as `{org_id|project_id}/{tag_key_short_name}` and
- # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
- # empty.
- "a_key": "A String",
- },
- "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
- # Specified using the full or partial URL. For instance template, specify
- # only the resource policy name.
- "A String",
- ],
- "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
- # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # To create a disk with one of the public operating system
- # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
- #
- # projects/debian-cloud/global/images/family/debian-9
- #
- #
- # Alternatively, use a specific version of a public operating system image:
- #
- # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
- #
- #
- # To create a disk with a custom image that you created, specify the
- # image name in the following format:
- #
- # global/images/my-custom-image
- #
- #
- # You can also specify a custom image by its image family, which returns
- # the latest version of the image in that family. Replace the image name
- # with family/family-name:
- #
- # global/images/family/my-image-family
- #
- #
- # If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source image. Required if the source image is
- # protected by a customer-supplied encryption key.
- #
- # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
- # encryption keys, so you cannot create disks for instances in a managed instance group if the
- # source images are encrypted with your own keys.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
- # instance boot disk, one of initializeParams.sourceSnapshot
- # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # us-central1-a/instantSnapshots/my-backup
- #
- #
- # If the source instant-snapshot is deleted later, this field will not be
- # set.
- "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
- # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # global/snapshots/my-backup
- #
- #
- # If the source snapshot is deleted later, this field will not be set.
- #
- # Note: You cannot create VMs in bulk using a snapshot as the source. Use
- # an image instead when you create VMs using
- # the bulk
- # insert method.
- "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source snapshot.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
- # this as a partial or full URL to the resource. For example, the following
- # are valid values:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
- # - projects/project/zones/zone/storagePools/storagePool
- # - zones/zone/storagePools/storagePool
- },
- "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
- # either SCSI or NVME. For most machine types, the
- # default is SCSI. Local SSDs can use either NVME or SCSI.
- # In certain configurations, persistent disks can use NVMe. For more
- # information, seeAbout
- # persistent disks.
- "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
- "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
- "A String",
- ],
- "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
- # disk is not allowed to be detached from the instance, or to be used as the
- # source of the snapshot creation, and the image creation. The instance with
- # at least one locked attached disk is not allow to be used as source of
- # machine image creation, instant snapshot creation, and not allowed to be
- # deleted with --keep-disk parameter set to true for locked disks.
- "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
- # in READ_WRITE mode.
- "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
- # field is set to PRESERVED if the LocalSSD data has been saved
- # to a persistent location by customer request. (see the
- # discard_local_ssd option on Stop/Suspend).
- # Read-only in the api.
- "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
- # these are public keys which are safe to store in public
- "dbs": [ # The Key Database (db).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "dbxs": [ # The forbidden key database (dbx).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "keks": [ # The Key Exchange Key (KEK).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "pk": { # The Platform Key (PK).
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- },
- "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
- # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # If desired, you can also attach existing non-root persistent disks using
- # this property. This field is only applicable for persistent disks.
- #
- # Note that for InstanceTemplate, specify the disk name for zonal disk,
- # and the URL for regional disk.
- "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
- },
- ],
- "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
- "A String",
- ],
- "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
- # e.g. 'Intel Ice Lake'.
- "rank": 42, # Preference of this instance selection. Lower number means higher
- # preference. MIG will first try to create a VM based on the machine-type
- # with lowest rank and fallback to next rank based on availability.
- # Machine types and instance selections with the same rank have the same
- # preference.
- },
- },
- "instanceSelections": { # Named instance selections configuring properties that the group will use
- # when creating new VMs.
- "a_key": {
- "disks": [ # List of disks to be attached to the instances created from this
- # selection.
- { # An instance-attached disk resource.
- "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
- # or X86_64.
- "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
- # deleted (but not when the disk is detached from the instance).
- "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
- # partition of the disk for its root filesystem.
- "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
- # running within the instance. This name can be used to reference the device
- # for mounting, resizing, and so on, from within the instance.
- #
- # If not specified, the server chooses a default device name to apply to this
- # disk, in the form persistent-disk-x, where x is a number
- # assigned by Google Compute Engine. This field is only applicable for
- # persistent disks.
- "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
- # encryption key.
- #
- # If you are creating a new disk, this field encrypts the new disk using
- # an encryption key that you provide. If you are attaching an existing
- # disk that is already encrypted, this field decrypts the disk using
- # the customer-supplied encryption key.
- #
- # If you encrypt a disk using a customer-supplied key, you must provide the
- # same key again when you attempt to use this resource at a later time. For
- # example, you must provide the key when you create a snapshot or an image
- # from the disk or when you attach the disk to a virtual machine instance.
- #
- # If you do not provide an encryption key, then the disk will be encrypted
- # using an automatically generated key and you do not need to provide a key
- # to use the disk later.
- #
- # Note:
- #
- # Instance templates do not storecustomer-supplied
- # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
- #
- # You cannot create VMs that have disks with customer-supplied keys using
- # the bulk
- # insert method.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "diskSizeGb": "A String", # The size of the disk in GB.
- "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
- # currently attached to another instance. If you try to force attach a zonal
- # disk to an instance, you will receive an error.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
- # boot disk. If you have many disks attached to an instance, each
- # disk would have a unique index number.
- "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This field is persisted and returned for instanceTemplate and not returned
- # in the context of instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- "architecture": "A String", # The architecture of the attached disk. Valid values are
- # arm64 or x86_64.
- "description": "A String", # An optional description. Provide this property when creating the disk.
- "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
- # of the instance. If a disk with the same name already exists in the given
- # region, the existing disk is attached to the new instance and the
- # new disk is not created.
- "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
- # 10 GB. If you specify a sourceImage, which is required for
- # boot disks, the default size is the size of the sourceImage.
- # If you do not specify a sourceImage, the default disk size
- # is 500 GB.
- "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
- # the default is pd-standard, specified using the full URL.
- # For example:
- #
- # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
- #
- #
- # For a full list of acceptable values, seePersistent disk
- # types. If you specify this field when creating a VM, you can provide
- # either the full or partial URL. For example, the following values are
- # valid:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
- # - projects/project/zones/zone/diskTypes/diskType
- # - zones/zone/diskTypes/diskType
- #
- #
- # If you specify this field when creating or updating an instance template
- # or all-instances configuration, specify the type of the disk, not the
- # URL. For example: pd-standard.
- "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- #
- # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
- # which is either SCSI or NVME. The default isSCSI.
- "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
- # persistent disks.
- "a_key": "A String",
- },
- "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
- # disk.
- "A String",
- ],
- "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
- "A String",
- ],
- "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
- # more than one instance.
- "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
- # is to use the existing disk.
- "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
- # of I/O operations per second that the disk can handle. Values must be
- # between 10,000 and 120,000. For more details, see theExtreme persistent
- # disk documentation.
- "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
- # number of throughput mb per second that the disk can handle. Values must
- # greater than or equal to 1.
- "replicaZones": [ # Required for each regional disk associated with the instance. Specify
- # the URLs of the zones where the disk should be replicated to.
- # You must provide exactly two replica zones, and one zone must be the same
- # as the instance zone.
- "A String",
- ],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
- # have the same definition as resource
- # manager tags. Keys and values can be either in numeric format,
- # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
- # format such as `{org_id|project_id}/{tag_key_short_name}` and
- # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
- # empty.
- "a_key": "A String",
- },
- "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
- # Specified using the full or partial URL. For instance template, specify
- # only the resource policy name.
- "A String",
- ],
- "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
- # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # To create a disk with one of the public operating system
- # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
- #
- # projects/debian-cloud/global/images/family/debian-9
- #
- #
- # Alternatively, use a specific version of a public operating system image:
- #
- # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
- #
- #
- # To create a disk with a custom image that you created, specify the
- # image name in the following format:
- #
- # global/images/my-custom-image
- #
- #
- # You can also specify a custom image by its image family, which returns
- # the latest version of the image in that family. Replace the image name
- # with family/family-name:
- #
- # global/images/family/my-image-family
- #
- #
- # If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source image. Required if the source image is
- # protected by a customer-supplied encryption key.
- #
- # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
- # encryption keys, so you cannot create disks for instances in a managed instance group if the
- # source images are encrypted with your own keys.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
- # instance boot disk, one of initializeParams.sourceSnapshot
- # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # us-central1-a/instantSnapshots/my-backup
- #
- #
- # If the source instant-snapshot is deleted later, this field will not be
- # set.
- "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
- # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # global/snapshots/my-backup
- #
- #
- # If the source snapshot is deleted later, this field will not be set.
- #
- # Note: You cannot create VMs in bulk using a snapshot as the source. Use
- # an image instead when you create VMs using
- # the bulk
- # insert method.
- "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source snapshot.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
- # this as a partial or full URL to the resource. For example, the following
- # are valid values:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
- # - projects/project/zones/zone/storagePools/storagePool
- # - zones/zone/storagePools/storagePool
- },
- "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
- # either SCSI or NVME. For most machine types, the
- # default is SCSI. Local SSDs can use either NVME or SCSI.
- # In certain configurations, persistent disks can use NVMe. For more
- # information, seeAbout
- # persistent disks.
- "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
- "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
- "A String",
- ],
- "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
- # disk is not allowed to be detached from the instance, or to be used as the
- # source of the snapshot creation, and the image creation. The instance with
- # at least one locked attached disk is not allow to be used as source of
- # machine image creation, instant snapshot creation, and not allowed to be
- # deleted with --keep-disk parameter set to true for locked disks.
- "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
- # in READ_WRITE mode.
- "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
- # field is set to PRESERVED if the LocalSSD data has been saved
- # to a persistent location by customer request. (see the
- # discard_local_ssd option on Stop/Suspend).
- # Read-only in the api.
- "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
- # these are public keys which are safe to store in public
- "dbs": [ # The Key Database (db).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "dbxs": [ # The forbidden key database (dbx).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "keks": [ # The Key Exchange Key (KEK).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "pk": { # The Platform Key (PK).
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- },
- "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
- # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # If desired, you can also attach existing non-root persistent disks using
- # this property. This field is only applicable for persistent disks.
- #
- # Note that for InstanceTemplate, specify the disk name for zonal disk,
- # and the URL for regional disk.
- "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
- },
- ],
- "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
- "A String",
- ],
- "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
- # e.g. 'Intel Ice Lake'.
- "rank": 42, # Preference of this instance selection. Lower number means higher
- # preference. MIG will first try to create a VM based on the machine-type
- # with lowest rank and fallback to next rank based on availability.
- # Machine types and instance selections with the same rank have the same
- # preference.
- },
- },
- "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to
- # create instances.
- "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of
- # more preemption than the minimum capacity user needs. MIG will create
- # only Standard VMs until it reaches standard_capacity_base and only
- # then will start using standard_capacity_percent_above_base to mix Spot
- # with Standard VMs.
- "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The
- # remaining percentage will use Spot VMs. The percentage applies only to
- # the capacity above standard_capacity_base.
- },
- },
- "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource.
- "instanceLifecyclePolicy": { # The repair policy for this managed instance group.
- "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field
- # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application
- # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed
- # VM by recreating it. For more information, see about repairing VMs in a MIG. - DO_NOTHING: MIG
- # does not repair a failed VM.
- "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest
- # configuration when repairing a VM. Valid options are:
- #
- #
- #
- # - NO (default): If configuration updates are available, they are not
- # forcefully applied during repair. Instead, configuration updates are
- # applied according to the group's update policy.
- #
- # - YES: If configuration updates are available, they are applied
- # during repair.
- "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the
- # instance during initialization when stopping / suspending an instance.
- # The Instance Group Manager will wait for a signal that indicates
- # successful initialization before stopping / suspending an instance.
- #
- # If a successful readiness signal is not sent before timeout, the
- # corresponding instance will not be stopped / suspended. Instead,
- # an error will be visible in the lastAttempt.errors field of
- # the managed instance in the listmanagedinstances
- # method.
- #
- # If metadataBasedReadinessSignal.timeoutSec is unset,
- # the Instance Group Manager will directly proceed to suspend / stop
- # instances, skipping initialization on them.
- "timeoutSec": 42, # The number of seconds to wait for a readiness signal during
- # initialization before timing out.
- },
- "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
- # unhealthy when the application running on that VM fails a health check.
- # Valid values are:
- #
- # - DEFAULT_ACTION (default): MIG uses the same action
- # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
- # - REPAIR: MIG automatically repairs an unhealthy VM by
- # recreating it.
- # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
- # For more information, see
- # About repairing VMs in a MIG.
- "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
- "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
- # Valid values are:
- #
- # - NO (default): MIG cannot change a VM's zone during a
- # repair.
- # - YES: MIG can select a different zone for the VM during
- # a repair.
- },
- },
- "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
- # instance group. The group uses this template to create all new instances
- # in the managed instance group. The templates for existing instances in the
- # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
- "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
- "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for
- # this managed instance group.
- "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to.
- "name": "A String", # The name of the managed instance group. The name must be 1-63 characters
- # long, and comply withRFC1035.
- "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary
- # to this Instance Group Manager.
- { # The named port. For example: <"http", 80>.
- "name": "A String", # The name for this named port.
- # The name must be 1-63 characters long, and comply withRFC1035.
- "port": 42, # The port number, which can be a value between 1 and 65535.
- },
- ],
- "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
- # as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
- # key-value pairs. Keys and values can be either in numeric format,
- # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
- # format such as `{org_id|project_id}/{tag_key_short_name}` and
- # `{tag_value_short_name}`. For more information, seeManage tags
- # for resources.
- "a_key": "A String",
- },
- },
- "region": "A String", # Output only. [Output Only] The URL of theregion
- # where the managed instance group resides (for regional resources).
- "resourcePolicies": { # Resource policies for this managed instance group.
- "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed
- # instance group.
- # It can be a full or partial URL. For example, the following are
- # all valid URLs to a workload policy:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
- # - projects/project/regions/region/resourcePolicies/resourcePolicy
- # - regions/region/resourcePolicies/resourcePolicy
- },
- "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
- "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
- "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines
- # this URL.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "serviceAccount": "A String", # The service account to be used as credentials for all operations performed
- # by the managed instance group on instances. The service accounts needs all
- # permissions required to create and delete instances.
- # By default, the service account
- # {projectNumber}@cloudservices.gserviceaccount.com is used.
- "standbyPolicy": { # Standby policy for stopped and suspended instances.
- "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or
- # stop a VM after that VM was created. The initial delay gives the
- # initialization script the time to prepare your VM for a quick scale out.
- # The value of initial delay must be between 0 and 3600 seconds. The
- # default value is 0.
- "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the
- # group scales out. The default mode is `MANUAL`.
- },
- "statefulPolicy": { # Stateful configuration for this Instanced Group Manager
- "preservedState": { # Configuration of preserved resources.
- "disks": { # Disks created on the instances that will be preserved on instance
- # delete, update, etc. This map is keyed with the device names of
- # the disks.
- "a_key": {
- "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the disk should be deleted after it
- # is no longer used by the group, e.g. when the given instance or
- # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
- },
- },
- "externalIPs": { # External network IPs assigned to the instances that will be preserved on
- # instance delete, update, etc. This map is keyed with the network
- # interface name.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- },
- },
- "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on
- # instance delete, update, etc. This map is keyed with the network
- # interface name.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- },
- },
- },
- },
- "status": { # Output only. [Output Only] The status of this managed instance group.
- "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group.
- "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision.
- # This value is in RFC3339 text format.
- "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has
- # been applied to all managed instances in the group.
- },
- "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG.
- # Currently only one accelerator topology is supported.
- {
- "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc.
- # The value is the same as configured in the WorkloadPolicy.
- "state": "A String", # Output only. [Output Only] The state of the accelerator topology.
- "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state
- # check.
- "error": { # Output only. [Output Only] Encountered errors.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field
- # has // RFC3339 //
- # text format.
- },
- },
- ],
- "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler
- # that targets this instance group manager.
- "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation.
- # targetSizePolicy.mode is set to BULK.
- "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress.
- "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance
- # operation.
- "error": { # Output only. [Output Only] Errors encountered during bulk instance operation.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance
- # operation. Timestamp is in RFC3339 text format.
- },
- },
- "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
- # in this managed instance group that have the status. Currently only shown
- # for TPU MIGs
- # instance group that have the status. For more information about how to
- # interpret each status check the instance lifecycle documentation.
- # Currently only shown for TPU MIGs.
- "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have DEPROVISIONING status.
- "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
- # have been deleted. Includes only instances that would be shown in the
- # listManagedInstances method and not all instances that have been
- # deleted in the lifetime of the MIG.
- # Does not include FlexStart instances that are waiting for the resources
- # availability, they are considered as 'pending'.
- "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have PENDING status, that is FlexStart instances that are waiting
- # for resources. Instances that do not exist because of the other reasons
- # are counted as 'non_existent'.
- "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have PENDING_STOP status.
- "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have PROVISIONING status.
- "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have REPAIRING status.
- "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have RUNNING status.
- "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have STAGING status.
- "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have STOPPED status.
- "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have STOPPING status.
- "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have SUSPENDED status.
- "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have SUSPENDING status.
- "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have TERMINATED status.
- },
- "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
- # stable state. A stable state means that: none of the instances in the
- # managed instance group is currently undergoing any type of change (for
- # example, creation, restart, or deletion); no future changes are scheduled
- # for instances in the managed instance group; and the managed instance
- # group itself is not being modified.
- "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager.
- "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
- # has stateful configuration, that is, if you have configured any items
- # in a stateful policy or in per-instance configs.
- # The group might report that it has no stateful configuration even when
- # there is still some preserved state on a managed instance, for example,
- # if you have deleted all PICs but not yet applied those deletions.
- "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
- # has stateful configuration, that is, if you have configured any items
- # in a stateful policy or in per-instance configs.
- # The group might report that it has no stateful configuration even when
- # there is still some preserved state on a managed instance, for example,
- # if you have deleted all PICs but not yet applied those deletions. This
- # field is deprecated in favor of has_stateful_config.
- "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances.
- "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations
- # (listed in the output of a listPerInstanceConfigs API call) have
- # status EFFECTIVE or there are no per-instance-configs.
- },
- },
- "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their
- # target version specified by version field on Instance Group
- # Manager.
- "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached
- # in this managed instance group, i.e. all instances are in their target
- # version. Instances' target version are specified byversion field on Instance Group Manager.
- },
- },
- "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
- # apply to all of the instances in the managed instance group.
- "A String",
- ],
- "targetSize": 42, # The target number of running instances for this managed instance group.
- # You can reduce this number by using the instanceGroupManager
- # deleteInstances or abandonInstances methods. Resizing the group also
- # changes this number.
- "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target
- # size.
- "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs
- # individually or all at once.
- },
- "targetSizeUnit": "A String", # The unit of measure for the target size.
- "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group.
- # This number changes when you:
- #
- # - Stop instance using the stopInstances
- # method or start instances using the startInstances
- # method.
- # - Manually change the targetStoppedSize using the update
- # method.
- "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group.
- # This number changes when you:
- #
- # - Suspend instance using the suspendInstances
- # method or resume instances using the resumeInstances
- # method.
- # - Manually change the targetSuspendedSize using the update
- # method.
- "updatePolicy": { # The update policy for this managed instance group.
- "instanceRedistributionType": "A String", # The
- # instance redistribution policy for regional managed instance groups.
- # Valid values are:
- #
- # - PROACTIVE (default): The group attempts to maintain an
- # even distribution of VM instances across zones in the region.
- # - NONE: For non-autoscaled groups, proactive
- # redistribution is disabled.
- "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
- # either a fixed number or, if the group has 10 or more instances, a
- # percentage. If you set a percentage, the number of instances is rounded
- # if necessary. The default value for maxSurge is a fixed
- # value equal to the number of zones in which the managed instance group
- # operates.
- #
- # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
- # process. An instance is considered available if all of the following
- # conditions are satisfied:
- #
- #
- #
- # - The instance's status is
- # RUNNING.
- # - If there is a health
- # check on the instance group, the instance's health check status
- # must be HEALTHY at least once. If there is no health check
- # on the group, then the instance only needs to have a status of
- # RUNNING to be considered available.
- #
- #
- # This value can be either a fixed number or, if the group has 10 or more
- # instances, a percentage. If you set a percentage, the number of instances
- # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
- # in which the managed instance group operates.
- #
- # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance
- # becomes available. This value must be from range [0, 3600].
- "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize
- # disruption as much as possible or to apply a more disruptive action than
- # is necessary.
- #
- # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
- # Compute Engine performs the necessary action to execute the update.
- # - To apply a more disruptive action than is strictly necessary, set the
- # minimal action to RESTART or REPLACE. For
- # example, Compute Engine does not need to restart a VM to change its
- # metadata. But if your application reads instance metadata only when a VM
- # is restarted, you can set the minimal action to RESTART in
- # order to pick up metadata changes.
- "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance.
- # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
- # as much as possible. RESTART to allow actions that can be
- # applied without instance replacing or REPLACE to allow all
- # possible actions. If the Updater determines that the minimal update
- # action needed is more disruptive than most disruptive allowed action you
- # specify it will not perform the update at all.
- "replacementMethod": "A String", # What action should be used to replace instances.
- # See minimal_action.REPLACE
- "type": "A String", # The type
- # of update process. You can specify either PROACTIVE so
- # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
- # to update.
- },
- "versions": [ # Specifies the instance templates used by this managed instance group to
- # create instances.
- #
- # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
- # group. This field overrides the top-level instanceTemplate
- # field. Read more about therelationships
- # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
- # remaining instances. For more information, read aboutcanary
- # updates.
- {
- "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
- # instance group. The group uses this template to create new instances in
- # the managed instance group until the `targetSize` for this version is
- # reached. The templates for existing instances in the group do not change
- # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases,
- # existing instances are updated until the `targetSize` for this version is
- # reached.
- "name": "A String", # Name of the version. Unique among all versions in the scope of this
- # managed instance group.
- "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version
- # even if instance_template remains unchanged.
- # Deprecated in favor of 'name'.
- "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
- # from the template will be equal to:
- #
- #
- # - If expressed as a fixed number, the minimum of either
- # targetSize.fixed or
- # instanceGroupManager.targetSize is used.
- # - if expressed as a percent, the targetSize
- # would be (targetSize.percent/100 *
- # InstanceGroupManager.targetSize) If there is a remainder, the
- # number is rounded.
- #
- # If unset, this version will update any remaining instances not
- # updated by another version. ReadStarting
- # a canary update for more information.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- },
- ],
- "zone": "A String", # Output only. [Output Only] The URL of azone
- # where the managed instance group is located (for zonal resources).
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Inserts or patches per-instance configurations for the managed instance
-group. perInstanceConfig.name serves as a key used to
-distinguish whether to perform insert or patch.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone
-where the managed instance group is located.
-It should conform to RFC1035. (required)
- instanceGroupManager: string, The name of the managed instance group.
-It should conform to RFC1035. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # InstanceGroupManagers.patchPerInstanceConfigs
- "perInstanceConfigs": [ # The list of per-instance configurations to insert or patch on this managed
- # instance group.
- {
- "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in
- # optimistic locking. It is ignored when inserting a per-instance
- # config. An up-to-date fingerprint must be provided in order to update an
- # existing per-instance configuration or the field needs to be unset.
- "name": "A String", # The name of a per-instance configuration and its corresponding instance.
- # Serves as a merge key during UpdatePerInstanceConfigs
- # operations, that is, if a per-instance configuration with the same name
- # exists then it will be updated, otherwise a new one will be created for the
- # VM instance with the same name. An attempt to create a per-instance
- # configuration for a VM instance that either doesn't exist or is not part
- # of the group will result in an error.
- "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
- # preserved state generated from a stateful policy.
- "disks": { # Preserved disks defined for this instance.
- # This map is keyed with the device names of the disks.
- "a_key": {
- "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
- # update, instance recreate operations. This flag is used to configure
- # if the disk should be deleted after it is no longer used by the group,
- # e.g. when the given instance or the whole MIG is deleted.
- # Note: disks attached in READ_ONLY mode cannot be
- # auto-deleted.
- "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
- # disk in READ_WRITE mode.
- "source": "A String", # The URL of the disk resource that is stateful and should be attached
- # to the VM instance.
- },
- },
- "externalIPs": { # Preserved external IPs defined for this instance.
- # This map is keyed with the name of the network interface.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- "ipAddress": { # Ip address representation
- "address": "A String", # The URL of the reservation for this IP address.
- "literal": "A String", # An IPv4 internal network address to assign to the instance for this
- # network interface.
- },
- },
- },
- "internalIPs": { # Preserved internal IPs defined for this instance.
- # This map is keyed with the name of the network interface.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- "ipAddress": { # Ip address representation
- "address": "A String", # The URL of the reservation for this IP address.
- "literal": "A String", # An IPv4 internal network address to assign to the instance for this
- # network interface.
- },
- },
- },
- "metadata": { # Preserved metadata defined for this instance.
- "a_key": "A String",
- },
- },
- "status": "A String", # The status of applying this per-instance configuration on the corresponding
- # managed instance.
- },
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified VM instances in the managed instance group to be
-immediately recreated. Each instance is recreated using the group's current
-configuration. This operation is marked as DONE when the flag
-is set even if the instances have not yet been recreated. You must
-separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking
-the status of managed instances.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is removed or deleted.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instances": [ # The URLs of one or more instances to recreate. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="resize">resize(project, zone, instanceGroupManager, size, requestId=None, x__xgafv=None)</code>
- <pre>Resizes the managed instance group. If you increase the size, the group
-creates new instances using the current instance template. If you decrease
-the size, the group deletes instances. The resize operation is markedDONE when the resize actions are scheduled even if the group
-has not yet added or deleted any instances. You must separately
-verify the status of the creating or deleting
-actions with thelistmanagedinstances
-method.
-
-When resizing down, the instance group arbitrarily chooses the order in
-which VMs are deleted. The group takes into account some VM attributes when
-making the selection including:
-
-+ The status of the VM instance.
-+ The health of the VM instance.
-+ The instance template version the VM is based on.
-+ For regional managed instance groups, the location of the VM instance.
-
-This list is subject to change.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is removed or deleted.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- size: integer, The number of running instances that the managed instance group should
-maintain at any given time. The group automatically adds or removes
-instances to maintain the number of instances specified by this parameter. (required)
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Resizes the managed instance group with advanced configuration options like
-disabling creation retries. This is an extended version of theresize method.
-
-If you increase the size of the instance group, the group creates new
-instances using the current instance template. If you decrease the size,
-the group deletes instances. The resize operation is markedDONE when the resize actions are scheduled even if the group
-has not yet added or deleted any instances. You must separately
-verify the status of the creating,creatingWithoutRetries, or deleting actions with
-the get
-orlistmanagedinstances
-method.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is removed or deleted.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all
- # instances initiated by this resize request only once. If there is an error
- # during creation, the managed instance group does not retry create this
- # instance, and we will decrease the targetSize of the request
- # instead. If the flag is false, the group attempts to recreate each instance
- # continuously until it succeeds.
- #
- # This flag matters only in the first attempt of creation of an instance.
- # After an instance is successfully created while this flag is enabled, the
- # instance behaves the same way as all the other instances created with a
- # regular resize request. In particular, if a running instance dies
- # unexpectedly at a later time and needs to be recreated, this mode does not
- # affect the recreation behavior in that scenario.
- #
- # This flag is applicable only to the current resize request. It does not
- # influence other resize requests in any way.
- #
- # You can see which instances is being creating in which mode by calling
- # the get or listManagedInstances API.
- "targetSize": 42, # The number of running instances that the managed instance group should
- # maintain at any given time. The group automatically adds or removes
- # instances to maintain the number of instances specified by this parameter.
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="resumeInstances">resumeInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-resumed. This method increases thetargetSize and decreases the targetSuspendedSize
-of the managed instance group by the number of instances that you resume.
-The resumeInstances operation is marked DONE if
-the resumeInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances
-method.
-
-In this request, you can only specify instances that are suspended. For
-example, if an instance was previously suspended using the suspendInstances
-method, it can be resumed using the resumeInstances method.
-
-If a health check is attached to the managed instance group, the specified
-instances will be verified as healthy after they are resumed.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instances": [ # The URLs of one or more instances to resume. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Motifies the autohealing policy for the instances in this managed
-instance group.
-[Deprecated] This method is deprecated. UseinstanceGroupManagers.patch instead.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the instance group manager. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "autoHealingPolicies": [
- {
- "autoHealingTriggers": { # Restricts what triggers autohealing.
- "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
- # this field controls whether to trigger VM autohealing based on a failed
- # health check. Valid values are:
- #
- # - ON (default): The group recreates running VMs that
- # fail the application-based health check.
- # - OFF: When set to OFF, you can still observe instance
- # health state, but the group does not recreate VMs that fail the
- # application-based health check. This is useful for troubleshooting and
- # setting up your health check configuration.
- },
- "healthCheck": "A String", # The URL for the health check that signals autohealing.
- "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
- # initialize and run its startup script. During a VM's initial delay
- # period, the MIG ignores unsuccessful health checks because the VM might
- # be in the startup process. This prevents the MIG from prematurely
- # recreating a VM. If the health check receives a healthy response during
- # the initial delay, it indicates that the startup process is complete and
- # the VM is ready. The value of initial delay must be between 0 and 3600
- # seconds. The default value is 0.
- "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
- # When 'percent' is used, the value is rounded if necessary.
- # The instance is considered available if all of the following conditions
- # are satisfied:
- # 1. Instance's status is RUNNING.
- # 2. Instance's currentAction is NONE (in particular its liveness health
- # check result was observed to be HEALTHY at least once as it passed
- # VERIFYING).
- # 3. There is no outgoing action on an instance triggered by IGM.
- #
- # By default, number of concurrently autohealed instances is smaller than
- # the managed instance group target size. However, if a zonal managed
- # instance group has only one instance, or a regional managed instance
- # group has only one instance per zone, autohealing will recreate these
- # instances when they become unhealthy.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- },
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Specifies the instance template to use when creating new instances in this
-group. The templates for existing instances in the group do not change
-unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
- # instance group. The group uses this template to create all new instances
- # in the managed instance group. The templates for existing instances in the
- # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Modifies the target pools to which all instances in this managed instance
-group are assigned. The target pools automatically apply to all of the
-instances in the managed instance group. This operation is markedDONE when you make the request even if the instances have not
-yet been added to their target pools. The change might take some time to
-apply to all of the instances in the group depending on the size of the
-group.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional
- # property to prevent conflicts when multiple users change the target pools
- # settings concurrently. Obtain the fingerprint with theinstanceGroupManagers.get
- # method. Then, include the fingerprint in your request to ensure that you
- # do not overwrite changes that were applied from another
- # concurrent request.
- "targetPools": [ # The list of target pool URLs that instances in this managed instance group
- # belong to. The managed instance group applies these target pools to all
- # of the instances in the group. Existing instances and new instances in the
- # group all receive these target pool settings.
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="startInstances">startInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-started. This method increases thetargetSize and decreases the targetStoppedSize
-of the managed instance group by the number of instances that you start.
-The startInstances operation is marked DONE if
-the startInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances
-method.
-
-In this request, you can only specify instances that are stopped. For
-example, if an instance was previously stopped using the stopInstances
-method, it can be started using the startInstances method.
-
-If a health check is attached to the managed instance group, the specified
-instances will be verified as healthy after they are started.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instances": [ # The URLs of one or more instances to start. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="stopInstances">stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-immediately stopped. You can only specify instances that are running in
-this request. This method reduces thetargetSize and increases the targetStoppedSize
-of the managed instance group by the number of instances that you stop.
-The stopInstances operation is marked DONE if
-the stopInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances
-method.
-
-If the standbyPolicy.initialDelaySec field is set, the group
-delays stopping the instances until initialDelaySec have
-passed from instance.creationTimestamp (that is, when the
-instance was created). This delay gives your application time to
-set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
-will be zero delay.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is stopped.
-
-Stopped instances can be started using the startInstances
-method.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "forceStop": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
- # stop the instances, skipping initialization on them.
- "instances": [ # The URLs of one or more instances to stop. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="suspendInstances">suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-immediately suspended. You can only specify instances that are running in
-this request. This method reduces thetargetSize and increases the targetSuspendedSize
-of the managed instance group by the number of instances that you suspend.
-The suspendInstances operation is marked DONE if
-the suspendInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances
-method.
-
-If the standbyPolicy.initialDelaySec field is set, the group
-delays suspension of the instances until initialDelaySec have
-passed from instance.creationTimestamp (that is, when the
-instance was created). This delay gives your application time to
-set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
-will be zero delay.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is suspended.
-
-Suspended instances can be resumed using the resumeInstances
-method.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of thezone where the managed
-instance group is located. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "forceSuspend": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
- # suspend the instances, skipping initialization on them.
- "instances": [ # The URLs of one or more instances to suspend. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
- <pre>Returns permissions that a caller has on the specified resource.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of the zone for this request. (required)
- resource: string, Name or id of the resource for this request. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed.
- "A String",
- ],
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
- # allowed.
- "A String",
- ],
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Updates a managed instance group using the information that you specify
-in the request.
-This operation is marked as DONE when the group is updated
-even if the instances in the group have not yet been updated. You must
-separately verify the status of the individual instances with thelistManagedInstances
-method.
-
-If you update your group to specify a new template or instance
-configuration, it's possible that your intended specification for each VM
-in the group is different from the current state of that VM. To learn how
-to apply an updated configuration to the VMs in a MIG, seeUpdating instances in
-a MIG.
-
-Args:
- project: string, Project ID for this request. (required)
- zone: string, The name of the zone
-where you want to create the managed instance group. (required)
- instanceGroupManager: string, The name of the instance group manager. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Represents a Managed Instance Group resource.
- #
- # An instance group is a collection of VM instances that you can manage as a
- # single entity. For more information, readInstance groups.
- #
- # For zonal Managed Instance Group, use the instanceGroupManagers
- # resource.
- #
- # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
- "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration
- # for the group.
- "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
- #
- # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's
- # instances to apply the configuration. To apply the configuration, set the
- # group's updatePolicy.type field to use proactive updates or
- # use the applyUpdatesToInstances method.
- "labels": { # The label key-value pairs that you want to patch onto the instance.
- "a_key": "A String",
- },
- "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For
- # more information, see Project and
- # instance metadata.
- "a_key": "A String",
- },
- },
- },
- "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify
- # only one value.
- {
- "autoHealingTriggers": { # Restricts what triggers autohealing.
- "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
- # this field controls whether to trigger VM autohealing based on a failed
- # health check. Valid values are:
- #
- # - ON (default): The group recreates running VMs that
- # fail the application-based health check.
- # - OFF: When set to OFF, you can still observe instance
- # health state, but the group does not recreate VMs that fail the
- # application-based health check. This is useful for troubleshooting and
- # setting up your health check configuration.
- },
- "healthCheck": "A String", # The URL for the health check that signals autohealing.
- "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
- # initialize and run its startup script. During a VM's initial delay
- # period, the MIG ignores unsuccessful health checks because the VM might
- # be in the startup process. This prevents the MIG from prematurely
- # recreating a VM. If the health check receives a healthy response during
- # the initial delay, it indicates that the startup process is complete and
- # the VM is ready. The value of initial delay must be between 0 and 3600
- # seconds. The default value is 0.
- "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
- # When 'percent' is used, the value is rounded if necessary.
- # The instance is considered available if all of the following conditions
- # are satisfied:
- # 1. Instance's status is RUNNING.
- # 2. Instance's currentAction is NONE (in particular its liveness health
- # check result was observed to be HEALTHY at least once as it passed
- # VERIFYING).
- # 3. There is no outgoing action on an instance triggered by IGM.
- #
- # By default, number of concurrently autohealed instances is smaller than
- # the managed instance group target size. However, if a zonal managed
- # instance group has only one instance, or a regional managed instance
- # group has only one instance per zone, autohealing will recreate these
- # instances when they become unhealthy.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- },
- ],
- "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of
- # all VMs in a MIG. The maximum character length is 58 and the name must
- # comply with RFC1035 format.
- #
- # When a VM is created in the group, the MIG appends a hyphen and a random
- # four-character string to the base instance name. If you want the MIG to
- # assign sequential numbers instead of a random string, then end the base
- # instance name with a hyphen followed by one or more hash symbols. The hash
- # symbols indicate the number of digits. For example, a base instance name of
- # "vm-###" results in "vm-001" as a VM name.
- # @pattern
- # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
- "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339
- # text format.
- "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances
- # in this managed instance group that are scheduled for each of those
- # actions.
- "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group
- # that are scheduled to be abandoned. Abandoning an instance removes it
- # from the managed instance group without deleting it.
- "adopting": 42, # [Output Only] The number of instances in the managed instance group that
- # are scheduled to be adopted or are currently being adopted.
- "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be created or are currently being created. If the group
- # fails to create any of these instances, it tries again until it creates
- # the instance successfully.
- #
- # If you have disabled creation retries, this field will not be populated;
- # instead, the creatingWithoutRetries field will be populated.
- "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group
- # will attempt to create atomically, in a batch mode. If the desired count
- # of instances can not be created, entire batch will be deleted and the
- # group will decrease its targetSize value accordingly.
- "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group
- # will attempt to create. The group attempts to create each instance
- # only once. If the group fails to create any of these instances, it
- # decreases the group's targetSize value accordingly.
- "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be deleted or are currently being deleted.
- "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are running and have no scheduled actions.
- "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group
- # is currently queuing.
- "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be recreated or are currently being being recreated.
- # Recreating an instance deletes the existing root persistent disk
- # and creates a new disk from the image that is defined in the
- # instance template.
- "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are being reconfigured with properties that do not require a restart
- # or a recreate action. For example, setting or removing target
- # pools for the instance.
- "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
@@ -19309,6 +14146,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -19622,6 +14460,5842 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Inserts or patches per-instance configurations for the managed instance
+group. perInstanceConfig.name serves as a key used to
+distinguish whether to perform insert or patch.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone
+where the managed instance group is located.
+It should conform to RFC1035. (required)
+ instanceGroupManager: string, The name of the managed instance group.
+It should conform to RFC1035. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # InstanceGroupManagers.patchPerInstanceConfigs
+ "perInstanceConfigs": [ # The list of per-instance configurations to insert or patch on this managed
+ # instance group.
+ {
+ "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in
+ # optimistic locking. It is ignored when inserting a per-instance
+ # config. An up-to-date fingerprint must be provided in order to update an
+ # existing per-instance configuration or the field needs to be unset.
+ "name": "A String", # The name of a per-instance configuration and its corresponding instance.
+ # Serves as a merge key during UpdatePerInstanceConfigs
+ # operations, that is, if a per-instance configuration with the same name
+ # exists then it will be updated, otherwise a new one will be created for the
+ # VM instance with the same name. An attempt to create a per-instance
+ # configuration for a VM instance that either doesn't exist or is not part
+ # of the group will result in an error.
+ "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
+ # preserved state generated from a stateful policy.
+ "disks": { # Preserved disks defined for this instance.
+ # This map is keyed with the device names of the disks.
+ "a_key": {
+ "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
+ # update, instance recreate operations. This flag is used to configure
+ # if the disk should be deleted after it is no longer used by the group,
+ # e.g. when the given instance or the whole MIG is deleted.
+ # Note: disks attached in READ_ONLY mode cannot be
+ # auto-deleted.
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
+ # disk in READ_WRITE mode.
+ "source": "A String", # The URL of the disk resource that is stateful and should be attached
+ # to the VM instance.
+ },
+ },
+ "externalIPs": { # Preserved external IPs defined for this instance.
+ # This map is keyed with the name of the network interface.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ "ipAddress": { # Ip address representation
+ "address": "A String", # The URL of the reservation for this IP address.
+ "literal": "A String", # An IPv4 internal network address to assign to the instance for this
+ # network interface.
+ },
+ },
+ },
+ "internalIPs": { # Preserved internal IPs defined for this instance.
+ # This map is keyed with the name of the network interface.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ "ipAddress": { # Ip address representation
+ "address": "A String", # The URL of the reservation for this IP address.
+ "literal": "A String", # An IPv4 internal network address to assign to the instance for this
+ # network interface.
+ },
+ },
+ },
+ "metadata": { # Preserved metadata defined for this instance.
+ "a_key": "A String",
+ },
+ },
+ "status": "A String", # The status of applying this per-instance configuration on the corresponding
+ # managed instance.
+ },
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified VM instances in the managed instance group to be
+immediately recreated. Each instance is recreated using the group's current
+configuration. This operation is marked as DONE when the flag
+is set even if the instances have not yet been recreated. You must
+separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking
+the status of managed instances.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is removed or deleted.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instances": [ # The URLs of one or more instances to recreate. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resize">resize(project, zone, instanceGroupManager, size, requestId=None, x__xgafv=None)</code>
+ <pre>Resizes the managed instance group. If you increase the size, the group
+creates new instances using the current instance template. If you decrease
+the size, the group deletes instances. The resize operation is markedDONE when the resize actions are scheduled even if the group
+has not yet added or deleted any instances. You must separately
+verify the status of the creating or deleting
+actions with thelistmanagedinstances
+method.
+
+When resizing down, the instance group arbitrarily chooses the order in
+which VMs are deleted. The group takes into account some VM attributes when
+making the selection including:
+
++ The status of the VM instance.
++ The health of the VM instance.
++ The instance template version the VM is based on.
++ For regional managed instance groups, the location of the VM instance.
+
+This list is subject to change.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is removed or deleted.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ size: integer, The number of running instances that the managed instance group should
+maintain at any given time. The group automatically adds or removes
+instances to maintain the number of instances specified by this parameter. (required)
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Resizes the managed instance group with advanced configuration options like
+disabling creation retries. This is an extended version of theresize method.
+
+If you increase the size of the instance group, the group creates new
+instances using the current instance template. If you decrease the size,
+the group deletes instances. The resize operation is markedDONE when the resize actions are scheduled even if the group
+has not yet added or deleted any instances. You must separately
+verify the status of the creating,creatingWithoutRetries, or deleting actions with
+the get
+orlistmanagedinstances
+method.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is removed or deleted.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all
+ # instances initiated by this resize request only once. If there is an error
+ # during creation, the managed instance group does not retry create this
+ # instance, and we will decrease the targetSize of the request
+ # instead. If the flag is false, the group attempts to recreate each instance
+ # continuously until it succeeds.
+ #
+ # This flag matters only in the first attempt of creation of an instance.
+ # After an instance is successfully created while this flag is enabled, the
+ # instance behaves the same way as all the other instances created with a
+ # regular resize request. In particular, if a running instance dies
+ # unexpectedly at a later time and needs to be recreated, this mode does not
+ # affect the recreation behavior in that scenario.
+ #
+ # This flag is applicable only to the current resize request. It does not
+ # influence other resize requests in any way.
+ #
+ # You can see which instances is being creating in which mode by calling
+ # the get or listManagedInstances API.
+ "targetSize": 42, # The number of running instances that the managed instance group should
+ # maintain at any given time. The group automatically adds or removes
+ # instances to maintain the number of instances specified by this parameter.
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resumeInstances">resumeInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+resumed. This method increases thetargetSize and decreases the targetSuspendedSize
+of the managed instance group by the number of instances that you resume.
+The resumeInstances operation is marked DONE if
+the resumeInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances
+method.
+
+In this request, you can only specify instances that are suspended. For
+example, if an instance was previously suspended using the suspendInstances
+method, it can be resumed using the resumeInstances method.
+
+If a health check is attached to the managed instance group, the specified
+instances will be verified as healthy after they are resumed.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instances": [ # The URLs of one or more instances to resume. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Motifies the autohealing policy for the instances in this managed
+instance group.
+[Deprecated] This method is deprecated. UseinstanceGroupManagers.patch instead.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "autoHealingPolicies": [
+ {
+ "autoHealingTriggers": { # Restricts what triggers autohealing.
+ "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
+ # this field controls whether to trigger VM autohealing based on a failed
+ # health check. Valid values are:
+ #
+ # - ON (default): The group recreates running VMs that
+ # fail the application-based health check.
+ # - OFF: When set to OFF, you can still observe instance
+ # health state, but the group does not recreate VMs that fail the
+ # application-based health check. This is useful for troubleshooting and
+ # setting up your health check configuration.
+ },
+ "healthCheck": "A String", # The URL for the health check that signals autohealing.
+ "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
+ # initialize and run its startup script. During a VM's initial delay
+ # period, the MIG ignores unsuccessful health checks because the VM might
+ # be in the startup process. This prevents the MIG from prematurely
+ # recreating a VM. If the health check receives a healthy response during
+ # the initial delay, it indicates that the startup process is complete and
+ # the VM is ready. The value of initial delay must be between 0 and 3600
+ # seconds. The default value is 0.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
+ # When 'percent' is used, the value is rounded if necessary.
+ # The instance is considered available if all of the following conditions
+ # are satisfied:
+ # 1. Instance's status is RUNNING.
+ # 2. Instance's currentAction is NONE (in particular its liveness health
+ # check result was observed to be HEALTHY at least once as it passed
+ # VERIFYING).
+ # 3. There is no outgoing action on an instance triggered by IGM.
+ #
+ # By default, number of concurrently autohealed instances is smaller than
+ # the managed instance group target size. However, if a zonal managed
+ # instance group has only one instance, or a regional managed instance
+ # group has only one instance per zone, autohealing will recreate these
+ # instances when they become unhealthy.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ },
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Specifies the instance template to use when creating new instances in this
+group. The templates for existing instances in the group do not change
+unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
+ # instance group. The group uses this template to create all new instances
+ # in the managed instance group. The templates for existing instances in the
+ # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Modifies the target pools to which all instances in this managed instance
+group are assigned. The target pools automatically apply to all of the
+instances in the managed instance group. This operation is markedDONE when you make the request even if the instances have not
+yet been added to their target pools. The change might take some time to
+apply to all of the instances in the group depending on the size of the
+group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional
+ # property to prevent conflicts when multiple users change the target pools
+ # settings concurrently. Obtain the fingerprint with theinstanceGroupManagers.get
+ # method. Then, include the fingerprint in your request to ensure that you
+ # do not overwrite changes that were applied from another
+ # concurrent request.
+ "targetPools": [ # The list of target pool URLs that instances in this managed instance group
+ # belong to. The managed instance group applies these target pools to all
+ # of the instances in the group. Existing instances and new instances in the
+ # group all receive these target pool settings.
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="startInstances">startInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+started. This method increases thetargetSize and decreases the targetStoppedSize
+of the managed instance group by the number of instances that you start.
+The startInstances operation is marked DONE if
+the startInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances
+method.
+
+In this request, you can only specify instances that are stopped. For
+example, if an instance was previously stopped using the stopInstances
+method, it can be started using the startInstances method.
+
+If a health check is attached to the managed instance group, the specified
+instances will be verified as healthy after they are started.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instances": [ # The URLs of one or more instances to start. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="stopInstances">stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+immediately stopped. You can only specify instances that are running in
+this request. This method reduces thetargetSize and increases the targetStoppedSize
+of the managed instance group by the number of instances that you stop.
+The stopInstances operation is marked DONE if
+the stopInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances
+method.
+
+If the standbyPolicy.initialDelaySec field is set, the group
+delays stopping the instances until initialDelaySec have
+passed from instance.creationTimestamp (that is, when the
+instance was created). This delay gives your application time to
+set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
+will be zero delay.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is stopped.
+
+Stopped instances can be started using the startInstances
+method.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "forceStop": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
+ # stop the instances, skipping initialization on them.
+ "instances": [ # The URLs of one or more instances to stop. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="suspendInstances">suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+immediately suspended. You can only specify instances that are running in
+this request. This method reduces thetargetSize and increases the targetSuspendedSize
+of the managed instance group by the number of instances that you suspend.
+The suspendInstances operation is marked DONE if
+the suspendInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances
+method.
+
+If the standbyPolicy.initialDelaySec field is set, the group
+delays suspension of the instances until initialDelaySec have
+passed from instance.creationTimestamp (that is, when the
+instance was created). This delay gives your application time to
+set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
+will be zero delay.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is suspended.
+
+Suspended instances can be resumed using the resumeInstances
+method.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone where the managed
+instance group is located. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "forceSuspend": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
+ # suspend the instances, skipping initialization on them.
+ "instances": [ # The URLs of one or more instances to suspend. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ # allowed.
+ "A String",
+ ],
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Updates a managed instance group using the information that you specify
+in the request.
+This operation is marked as DONE when the group is updated
+even if the instances in the group have not yet been updated. You must
+separately verify the status of the individual instances with thelistManagedInstances
+method.
+
+If you update your group to specify a new template or instance
+configuration, it's possible that your intended specification for each VM
+in the group is different from the current state of that VM. To learn how
+to apply an updated configuration to the VMs in a MIG, seeUpdating instances in
+a MIG.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone
+where you want to create the managed instance group. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Managed Instance Group resource.
+ #
+ # An instance group is a collection of VM instances that you can manage as a
+ # single entity. For more information, readInstance groups.
+ #
+ # For zonal Managed Instance Group, use the instanceGroupManagers
+ # resource.
+ #
+ # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
+ "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration
+ # for the group.
+ "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
+ #
+ # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's
+ # instances to apply the configuration. To apply the configuration, set the
+ # group's updatePolicy.type field to use proactive updates or
+ # use the applyUpdatesToInstances method.
+ "labels": { # The label key-value pairs that you want to patch onto the instance.
+ "a_key": "A String",
+ },
+ "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For
+ # more information, see Project and
+ # instance metadata.
+ "a_key": "A String",
+ },
+ },
+ },
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify
+ # only one value.
+ {
+ "autoHealingTriggers": { # Restricts what triggers autohealing.
+ "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
+ # this field controls whether to trigger VM autohealing based on a failed
+ # health check. Valid values are:
+ #
+ # - ON (default): The group recreates running VMs that
+ # fail the application-based health check.
+ # - OFF: When set to OFF, you can still observe instance
+ # health state, but the group does not recreate VMs that fail the
+ # application-based health check. This is useful for troubleshooting and
+ # setting up your health check configuration.
+ },
+ "healthCheck": "A String", # The URL for the health check that signals autohealing.
+ "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
+ # initialize and run its startup script. During a VM's initial delay
+ # period, the MIG ignores unsuccessful health checks because the VM might
+ # be in the startup process. This prevents the MIG from prematurely
+ # recreating a VM. If the health check receives a healthy response during
+ # the initial delay, it indicates that the startup process is complete and
+ # the VM is ready. The value of initial delay must be between 0 and 3600
+ # seconds. The default value is 0.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
+ # When 'percent' is used, the value is rounded if necessary.
+ # The instance is considered available if all of the following conditions
+ # are satisfied:
+ # 1. Instance's status is RUNNING.
+ # 2. Instance's currentAction is NONE (in particular its liveness health
+ # check result was observed to be HEALTHY at least once as it passed
+ # VERIFYING).
+ # 3. There is no outgoing action on an instance triggered by IGM.
+ #
+ # By default, number of concurrently autohealed instances is smaller than
+ # the managed instance group target size. However, if a zonal managed
+ # instance group has only one instance, or a regional managed instance
+ # group has only one instance per zone, autohealing will recreate these
+ # instances when they become unhealthy.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ },
+ ],
+ "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of
+ # all VMs in a MIG. The maximum character length is 58 and the name must
+ # comply with RFC1035 format.
+ #
+ # When a VM is created in the group, the MIG appends a hyphen and a random
+ # four-character string to the base instance name. If you want the MIG to
+ # assign sequential numbers instead of a random string, then end the base
+ # instance name with a hyphen followed by one or more hash symbols. The hash
+ # symbols indicate the number of digits. For example, a base instance name of
+ # "vm-###" results in "vm-001" as a VM name.
+ # @pattern
+ # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
+ "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339
+ # text format.
+ "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances
+ # in this managed instance group that are scheduled for each of those
+ # actions.
+ "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group
+ # that are scheduled to be abandoned. Abandoning an instance removes it
+ # from the managed instance group without deleting it.
+ "adopting": 42, # [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be adopted or are currently being adopted.
+ "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be created or are currently being created. If the group
+ # fails to create any of these instances, it tries again until it creates
+ # the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated;
+ # instead, the creatingWithoutRetries field will be populated.
+ "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group
+ # will attempt to create atomically, in a batch mode. If the desired count
+ # of instances can not be created, entire batch will be deleted and the
+ # group will decrease its targetSize value accordingly.
+ "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group
+ # will attempt to create. The group attempts to create each instance
+ # only once. If the group fails to create any of these instances, it
+ # decreases the group's targetSize value accordingly.
+ "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be deleted or are currently being deleted.
+ "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are running and have no scheduled actions.
+ "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group
+ # is currently queuing.
+ "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be recreated or are currently being being recreated.
+ # Recreating an instance deletes the existing root persistent disk
+ # and creates a new disk from the image that is defined in the
+ # instance template.
+ "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are being reconfigured with properties that do not require a restart
+ # or a recreate action. For example, setting or removing target
+ # pools for the instance.
+ "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
+ "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be resumed or are currently being resumed.
+ "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be started or are currently being started.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be stopped or are currently being stopped.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be suspended or are currently being suspended.
+ "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are being verified. See the managedInstances[].currentAction
+ # property in the listManagedInstances method documentation.
+ },
+ "description": "A String", # An optional description of this resource.
+ "distributionPolicy": { # Policy specifying the intended distribution of managed instances across
+ # zones in a regional managed instance group.
+ "targetShape": "A String", # The distribution shape to which the group converges either proactively or
+ # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
+ "zones": [ # Zones where the regional managed instance group will create and manage
+ # its instances.
+ {
+ "zone": "A String", # The URL of thezone.
+ # The zone must exist in the region where the managed instance group is
+ # located.
+ },
+ ],
+ },
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER.
+ "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking.
+ # It will be ignored when inserting an InstanceGroupManager. An up-to-date
+ # fingerprint must be provided in order to update the InstanceGroupManager,
+ # otherwise the request will fail with error412 conditionNotMet.
+ #
+ # To see the latest fingerprint, make a get() request to
+ # retrieve an InstanceGroupManager.
+ "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+ # generates this identifier.
+ "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple
+ # types of machines.
+ # Instance flexibility configuration on MIG overrides instance
+ # template configuration.
+ "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
+ # when creating new VMs.
+ "a_key": {
+ "disks": [ # List of disks to be attached to the instances created from this
+ # selection.
+ { # An instance-attached disk resource.
+ "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
+ # or X86_64.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+ # deleted (but not when the disk is detached from the instance).
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+ # partition of the disk for its root filesystem.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+ # running within the instance. This name can be used to reference the device
+ # for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this
+ # disk, in the form persistent-disk-x, where x is a number
+ # assigned by Google Compute Engine. This field is only applicable for
+ # persistent disks.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+ # encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using
+ # an encryption key that you provide. If you are attaching an existing
+ # disk that is already encrypted, this field decrypts the disk using
+ # the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the
+ # same key again when you attempt to use this resource at a later time. For
+ # example, you must provide the key when you create a snapshot or an image
+ # from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted
+ # using an automatically generated key and you do not need to provide a key
+ # to use the disk later.
+ #
+ # Note:
+ #
+ # Instance templates do not storecustomer-supplied
+ # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+ #
+ # You cannot create VMs that have disks with customer-supplied keys using
+ # the bulk
+ # insert method.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "diskSizeGb": "A String", # The size of the disk in GB.
+ "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+ # currently attached to another instance. If you try to force attach a zonal
+ # disk to an instance, you will receive an error.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
+ # boot disk. If you have many disks attached to an instance, each
+ # disk would have a unique index number.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This field is persisted and returned for instanceTemplate and not returned
+ # in the context of instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ "architecture": "A String", # The architecture of the attached disk. Valid values are
+ # arm64 or x86_64.
+ "description": "A String", # An optional description. Provide this property when creating the disk.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+ # of the instance. If a disk with the same name already exists in the given
+ # region, the existing disk is attached to the new instance and the
+ # new disk is not created.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+ # 10 GB. If you specify a sourceImage, which is required for
+ # boot disks, the default size is the size of the sourceImage.
+ # If you do not specify a sourceImage, the default disk size
+ # is 500 GB.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+ # the default is pd-standard, specified using the full URL.
+ # For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ #
+ # For a full list of acceptable values, seePersistent disk
+ # types. If you specify this field when creating a VM, you can provide
+ # either the full or partial URL. For example, the following values are
+ # valid:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
+ #
+ #
+ # If you specify this field when creating or updating an instance template
+ # or all-instances configuration, specify the type of the disk, not the
+ # URL. For example: pd-standard.
+ "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ #
+ # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+ # which is either SCSI or NVME. The default isSCSI.
+ "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+ # persistent disks.
+ "a_key": "A String",
+ },
+ "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+ # disk.
+ "A String",
+ ],
+ "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+ "A String",
+ ],
+ "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+ # more than one instance.
+ "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+ # is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+ # of I/O operations per second that the disk can handle. Values must be
+ # between 10,000 and 120,000. For more details, see theExtreme persistent
+ # disk documentation.
+ "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+ # number of throughput mb per second that the disk can handle. Values must
+ # greater than or equal to 1.
+ "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+ # the URLs of the zones where the disk should be replicated to.
+ # You must provide exactly two replica zones, and one zone must be the same
+ # as the instance zone.
+ "A String",
+ ],
+ "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ # have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+ # format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
+ # empty.
+ "a_key": "A String",
+ },
+ "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+ # Specified using the full or partial URL. For instance template, specify
+ # only the resource policy name.
+ "A String",
+ ],
+ "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+ # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # To create a disk with one of the public operating system
+ # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-9
+ #
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+ #
+ #
+ # To create a disk with a custom image that you created, specify the
+ # image name in the following format:
+ #
+ # global/images/my-custom-image
+ #
+ #
+ # You can also specify a custom image by its image family, which returns
+ # the latest version of the image in that family. Replace the image name
+ # with family/family-name:
+ #
+ # global/images/family/my-image-family
+ #
+ #
+ # If the source image is deleted later, this field will not be set.
+ "sourceImageEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source image. Required if the source image is
+ # protected by a customer-supplied encryption key.
+ #
+ # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+ # encryption keys, so you cannot create disks for instances in a managed instance group if the
+ # source images are encrypted with your own keys.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+ # instance boot disk, one of initializeParams.sourceSnapshot
+ # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # us-central1-a/instantSnapshots/my-backup
+ #
+ #
+ # If the source instant-snapshot is deleted later, this field will not be
+ # set.
+ "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+ # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # global/snapshots/my-backup
+ #
+ #
+ # If the source snapshot is deleted later, this field will not be set.
+ #
+ # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+ # an image instead when you create VMs using
+ # the bulk
+ # insert method.
+ "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source snapshot.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+ # this as a partial or full URL to the resource. For example, the following
+ # are valid values:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+ # - projects/project/zones/zone/storagePools/storagePool
+ # - zones/zone/storagePools/storagePool
+ },
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+ # either SCSI or NVME. For most machine types, the
+ # default is SCSI. Local SSDs can use either NVME or SCSI.
+ # In certain configurations, persistent disks can use NVMe. For more
+ # information, seeAbout
+ # persistent disks.
+ "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+ "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
+ # disk is not allowed to be detached from the instance, or to be used as the
+ # source of the snapshot creation, and the image creation. The instance with
+ # at least one locked attached disk is not allow to be used as source of
+ # machine image creation, instant snapshot creation, and not allowed to be
+ # deleted with --keep-disk parameter set to true for locked disks.
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+ # in READ_WRITE mode.
+ "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+ # field is set to PRESERVED if the LocalSSD data has been saved
+ # to a persistent location by customer request. (see the
+ # discard_local_ssd option on Stop/Suspend).
+ # Read-only in the api.
+ "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
+ # these are public keys which are safe to store in public
+ "dbs": [ # The Key Database (db).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "dbxs": [ # The forbidden key database (dbx).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "keks": [ # The Key Exchange Key (KEK).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "pk": { # The Platform Key (PK).
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ },
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+ # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # If desired, you can also attach existing non-root persistent disks using
+ # this property. This field is only applicable for persistent disks.
+ #
+ # Note that for InstanceTemplate, specify the disk name for zonal disk,
+ # and the URL for regional disk.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+ "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
+ # URLs to the license resource. Unlike regular licenses, user provided
+ # licenses can be modified after the disk is created.
+ "A String",
+ ],
+ },
+ ],
+ "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
+ "A String",
+ ],
+ "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+ # e.g. 'Intel Ice Lake'.
+ "rank": 42, # Preference of this instance selection. Lower number means higher
+ # preference. MIG will first try to create a VM based on the machine-type
+ # with lowest rank and fallback to next rank based on availability.
+ # Machine types and instance selections with the same rank have the same
+ # preference.
+ },
+ },
+ "instanceSelections": { # Named instance selections configuring properties that the group will use
+ # when creating new VMs.
+ "a_key": {
+ "disks": [ # List of disks to be attached to the instances created from this
+ # selection.
+ { # An instance-attached disk resource.
+ "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
+ # or X86_64.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+ # deleted (but not when the disk is detached from the instance).
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+ # partition of the disk for its root filesystem.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+ # running within the instance. This name can be used to reference the device
+ # for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this
+ # disk, in the form persistent-disk-x, where x is a number
+ # assigned by Google Compute Engine. This field is only applicable for
+ # persistent disks.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+ # encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using
+ # an encryption key that you provide. If you are attaching an existing
+ # disk that is already encrypted, this field decrypts the disk using
+ # the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the
+ # same key again when you attempt to use this resource at a later time. For
+ # example, you must provide the key when you create a snapshot or an image
+ # from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted
+ # using an automatically generated key and you do not need to provide a key
+ # to use the disk later.
+ #
+ # Note:
+ #
+ # Instance templates do not storecustomer-supplied
+ # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+ #
+ # You cannot create VMs that have disks with customer-supplied keys using
+ # the bulk
+ # insert method.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "diskSizeGb": "A String", # The size of the disk in GB.
+ "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+ # currently attached to another instance. If you try to force attach a zonal
+ # disk to an instance, you will receive an error.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
+ # boot disk. If you have many disks attached to an instance, each
+ # disk would have a unique index number.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This field is persisted and returned for instanceTemplate and not returned
+ # in the context of instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ "architecture": "A String", # The architecture of the attached disk. Valid values are
+ # arm64 or x86_64.
+ "description": "A String", # An optional description. Provide this property when creating the disk.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+ # of the instance. If a disk with the same name already exists in the given
+ # region, the existing disk is attached to the new instance and the
+ # new disk is not created.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+ # 10 GB. If you specify a sourceImage, which is required for
+ # boot disks, the default size is the size of the sourceImage.
+ # If you do not specify a sourceImage, the default disk size
+ # is 500 GB.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+ # the default is pd-standard, specified using the full URL.
+ # For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ #
+ # For a full list of acceptable values, seePersistent disk
+ # types. If you specify this field when creating a VM, you can provide
+ # either the full or partial URL. For example, the following values are
+ # valid:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
+ #
+ #
+ # If you specify this field when creating or updating an instance template
+ # or all-instances configuration, specify the type of the disk, not the
+ # URL. For example: pd-standard.
+ "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ #
+ # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+ # which is either SCSI or NVME. The default isSCSI.
+ "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+ # persistent disks.
+ "a_key": "A String",
+ },
+ "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+ # disk.
+ "A String",
+ ],
+ "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+ "A String",
+ ],
+ "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+ # more than one instance.
+ "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+ # is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+ # of I/O operations per second that the disk can handle. Values must be
+ # between 10,000 and 120,000. For more details, see theExtreme persistent
+ # disk documentation.
+ "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+ # number of throughput mb per second that the disk can handle. Values must
+ # greater than or equal to 1.
+ "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+ # the URLs of the zones where the disk should be replicated to.
+ # You must provide exactly two replica zones, and one zone must be the same
+ # as the instance zone.
+ "A String",
+ ],
+ "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ # have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+ # format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
+ # empty.
+ "a_key": "A String",
+ },
+ "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+ # Specified using the full or partial URL. For instance template, specify
+ # only the resource policy name.
+ "A String",
+ ],
+ "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+ # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # To create a disk with one of the public operating system
+ # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-9
+ #
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+ #
+ #
+ # To create a disk with a custom image that you created, specify the
+ # image name in the following format:
+ #
+ # global/images/my-custom-image
+ #
+ #
+ # You can also specify a custom image by its image family, which returns
+ # the latest version of the image in that family. Replace the image name
+ # with family/family-name:
+ #
+ # global/images/family/my-image-family
+ #
+ #
+ # If the source image is deleted later, this field will not be set.
+ "sourceImageEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source image. Required if the source image is
+ # protected by a customer-supplied encryption key.
+ #
+ # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+ # encryption keys, so you cannot create disks for instances in a managed instance group if the
+ # source images are encrypted with your own keys.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+ # instance boot disk, one of initializeParams.sourceSnapshot
+ # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # us-central1-a/instantSnapshots/my-backup
+ #
+ #
+ # If the source instant-snapshot is deleted later, this field will not be
+ # set.
+ "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+ # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # global/snapshots/my-backup
+ #
+ #
+ # If the source snapshot is deleted later, this field will not be set.
+ #
+ # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+ # an image instead when you create VMs using
+ # the bulk
+ # insert method.
+ "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source snapshot.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+ # this as a partial or full URL to the resource. For example, the following
+ # are valid values:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+ # - projects/project/zones/zone/storagePools/storagePool
+ # - zones/zone/storagePools/storagePool
+ },
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+ # either SCSI or NVME. For most machine types, the
+ # default is SCSI. Local SSDs can use either NVME or SCSI.
+ # In certain configurations, persistent disks can use NVMe. For more
+ # information, seeAbout
+ # persistent disks.
+ "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+ "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
+ # disk is not allowed to be detached from the instance, or to be used as the
+ # source of the snapshot creation, and the image creation. The instance with
+ # at least one locked attached disk is not allow to be used as source of
+ # machine image creation, instant snapshot creation, and not allowed to be
+ # deleted with --keep-disk parameter set to true for locked disks.
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+ # in READ_WRITE mode.
+ "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+ # field is set to PRESERVED if the LocalSSD data has been saved
+ # to a persistent location by customer request. (see the
+ # discard_local_ssd option on Stop/Suspend).
+ # Read-only in the api.
+ "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
+ # these are public keys which are safe to store in public
+ "dbs": [ # The Key Database (db).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "dbxs": [ # The forbidden key database (dbx).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "keks": [ # The Key Exchange Key (KEK).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "pk": { # The Platform Key (PK).
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ },
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+ # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # If desired, you can also attach existing non-root persistent disks using
+ # this property. This field is only applicable for persistent disks.
+ #
+ # Note that for InstanceTemplate, specify the disk name for zonal disk,
+ # and the URL for regional disk.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+ "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
+ # URLs to the license resource. Unlike regular licenses, user provided
+ # licenses can be modified after the disk is created.
+ "A String",
+ ],
+ },
+ ],
+ "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
+ "A String",
+ ],
+ "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+ # e.g. 'Intel Ice Lake'.
+ "rank": 42, # Preference of this instance selection. Lower number means higher
+ # preference. MIG will first try to create a VM based on the machine-type
+ # with lowest rank and fallback to next rank based on availability.
+ # Machine types and instance selections with the same rank have the same
+ # preference.
+ },
+ },
+ "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to
+ # create instances.
+ "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of
+ # more preemption than the minimum capacity user needs. MIG will create
+ # only Standard VMs until it reaches standard_capacity_base and only
+ # then will start using standard_capacity_percent_above_base to mix Spot
+ # with Standard VMs.
+ "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The
+ # remaining percentage will use Spot VMs. The percentage applies only to
+ # the capacity above standard_capacity_base.
+ },
+ },
+ "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource.
+ "instanceLifecyclePolicy": { # The repair policy for this managed instance group.
+ "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field
+ # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application
+ # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed
+ # VM by recreating it. For more information, see about repairing VMs in a MIG. - DO_NOTHING: MIG
+ # does not repair a failed VM.
+ "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest
+ # configuration when repairing a VM. Valid options are:
+ #
+ #
+ #
+ # - NO (default): If configuration updates are available, they are not
+ # forcefully applied during repair. Instead, configuration updates are
+ # applied according to the group's update policy.
+ #
+ # - YES: If configuration updates are available, they are applied
+ # during repair.
+ "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the
+ # instance during initialization when stopping / suspending an instance.
+ # The Instance Group Manager will wait for a signal that indicates
+ # successful initialization before stopping / suspending an instance.
+ #
+ # If a successful readiness signal is not sent before timeout, the
+ # corresponding instance will not be stopped / suspended. Instead,
+ # an error will be visible in the lastAttempt.errors field of
+ # the managed instance in the listmanagedinstances
+ # method.
+ #
+ # If metadataBasedReadinessSignal.timeoutSec is unset,
+ # the Instance Group Manager will directly proceed to suspend / stop
+ # instances, skipping initialization on them.
+ "timeoutSec": 42, # The number of seconds to wait for a readiness signal during
+ # initialization before timing out.
+ },
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
+ "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
+ "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+ # Valid values are:
+ #
+ # - NO (default): MIG cannot change a VM's zone during a
+ # repair.
+ # - YES: MIG can select a different zone for the VM during
+ # a repair.
+ },
+ },
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
+ # instance group. The group uses this template to create all new instances
+ # in the managed instance group. The templates for existing instances in the
+ # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
+ "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
+ "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for
+ # this managed instance group.
+ "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters
+ # long, and comply withRFC1035.
+ "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary
+ # to this Instance Group Manager.
+ { # The named port. For example: <"http", 80>.
+ "name": "A String", # The name for this named port.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ # key-value pairs. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+ # format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. For more information, seeManage tags
+ # for resources.
+ "a_key": "A String",
+ },
+ },
+ "region": "A String", # Output only. [Output Only] The URL of theregion
+ # where the managed instance group resides (for regional resources).
+ "resourcePolicies": { # Resource policies for this managed instance group.
+ "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed
+ # instance group.
+ # It can be a full or partial URL. For example, the following are
+ # all valid URLs to a workload policy:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
+ # - projects/project/regions/region/resourcePolicies/resourcePolicy
+ # - regions/region/resourcePolicies/resourcePolicy
+ },
+ "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
+ "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines
+ # this URL.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceAccount": "A String", # The service account to be used as credentials for all operations performed
+ # by the managed instance group on instances. The service accounts needs all
+ # permissions required to create and delete instances.
+ # By default, the service account
+ # {projectNumber}@cloudservices.gserviceaccount.com is used.
+ "standbyPolicy": { # Standby policy for stopped and suspended instances.
+ "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or
+ # stop a VM after that VM was created. The initial delay gives the
+ # initialization script the time to prepare your VM for a quick scale out.
+ # The value of initial delay must be between 0 and 3600 seconds. The
+ # default value is 0.
+ "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the
+ # group scales out. The default mode is `MANUAL`.
+ },
+ "statefulPolicy": { # Stateful configuration for this Instanced Group Manager
+ "preservedState": { # Configuration of preserved resources.
+ "disks": { # Disks created on the instances that will be preserved on instance
+ # delete, update, etc. This map is keyed with the device names of
+ # the disks.
+ "a_key": {
+ "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the disk should be deleted after it
+ # is no longer used by the group, e.g. when the given instance or
+ # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
+ },
+ },
+ "externalIPs": { # External network IPs assigned to the instances that will be preserved on
+ # instance delete, update, etc. This map is keyed with the network
+ # interface name.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ },
+ },
+ "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on
+ # instance delete, update, etc. This map is keyed with the network
+ # interface name.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ },
+ },
+ },
+ },
+ "status": { # Output only. [Output Only] The status of this managed instance group.
+ "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group.
+ "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision.
+ # This value is in RFC3339 text format.
+ "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has
+ # been applied to all managed instances in the group.
+ },
+ "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG.
+ # Currently only one accelerator topology is supported.
+ {
+ "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc.
+ # The value is the same as configured in the WorkloadPolicy.
+ "state": "A String", # Output only. [Output Only] The state of the accelerator topology.
+ "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state
+ # check.
+ "error": { # Output only. [Output Only] Encountered errors.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field
+ # has // RFC3339 //
+ # text format.
+ },
+ },
+ ],
+ "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler
+ # that targets this instance group manager.
+ "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation.
+ # targetSizePolicy.mode is set to BULK.
+ "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress.
+ "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance
+ # operation.
+ "error": { # Output only. [Output Only] Errors encountered during bulk instance operation.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance
+ # operation. Timestamp is in RFC3339 text format.
+ },
+ },
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
+ "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
+ # stable state. A stable state means that: none of the instances in the
+ # managed instance group is currently undergoing any type of change (for
+ # example, creation, restart, or deletion); no future changes are scheduled
+ # for instances in the managed instance group; and the managed instance
+ # group itself is not being modified.
+ "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager.
+ "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
+ # has stateful configuration, that is, if you have configured any items
+ # in a stateful policy or in per-instance configs.
+ # The group might report that it has no stateful configuration even when
+ # there is still some preserved state on a managed instance, for example,
+ # if you have deleted all PICs but not yet applied those deletions.
+ "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
+ # has stateful configuration, that is, if you have configured any items
+ # in a stateful policy or in per-instance configs.
+ # The group might report that it has no stateful configuration even when
+ # there is still some preserved state on a managed instance, for example,
+ # if you have deleted all PICs but not yet applied those deletions. This
+ # field is deprecated in favor of has_stateful_config.
+ "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances.
+ "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations
+ # (listed in the output of a listPerInstanceConfigs API call) have
+ # status EFFECTIVE or there are no per-instance-configs.
+ },
+ },
+ "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their
+ # target version specified by version field on Instance Group
+ # Manager.
+ "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached
+ # in this managed instance group, i.e. all instances are in their target
+ # version. Instances' target version are specified byversion field on Instance Group Manager.
+ },
+ },
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
+ # apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group.
+ # You can reduce this number by using the instanceGroupManager
+ # deleteInstances or abandonInstances methods. Resizing the group also
+ # changes this number.
+ "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target
+ # size.
+ "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs
+ # individually or all at once.
+ },
+ "targetSizeUnit": "A String", # The unit of measure for the target size.
+ "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group.
+ # This number changes when you:
+ #
+ # - Stop instance using the stopInstances
+ # method or start instances using the startInstances
+ # method.
+ # - Manually change the targetStoppedSize using the update
+ # method.
+ "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group.
+ # This number changes when you:
+ #
+ # - Suspend instance using the suspendInstances
+ # method or resume instances using the resumeInstances
+ # method.
+ # - Manually change the targetSuspendedSize using the update
+ # method.
+ "updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
+ "instanceRedistributionType": "A String", # The
+ # instance redistribution policy for regional managed instance groups.
+ # Valid values are:
+ #
+ # - PROACTIVE (default): The group attempts to maintain an
+ # even distribution of VM instances across zones in the region.
+ # - NONE: For non-autoscaled groups, proactive
+ # redistribution is disabled.
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
+ # either a fixed number or, if the group has 10 or more instances, a
+ # percentage. If you set a percentage, the number of instances is rounded
+ # if necessary. The default value for maxSurge is a fixed
+ # value equal to the number of zones in which the managed instance group
+ # operates.
+ #
+ # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
+ # process. An instance is considered available if all of the following
+ # conditions are satisfied:
+ #
+ #
+ #
+ # - The instance's status is
+ # RUNNING.
+ # - If there is a health
+ # check on the instance group, the instance's health check status
+ # must be HEALTHY at least once. If there is no health check
+ # on the group, then the instance only needs to have a status of
+ # RUNNING to be considered available.
+ #
+ #
+ # This value can be either a fixed number or, if the group has 10 or more
+ # instances, a percentage. If you set a percentage, the number of instances
+ # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
+ # in which the managed instance group operates.
+ #
+ # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance
+ # becomes available. This value must be from range [0, 3600].
+ "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize
+ # disruption as much as possible or to apply a more disruptive action than
+ # is necessary.
+ #
+ # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
+ # Compute Engine performs the necessary action to execute the update.
+ # - To apply a more disruptive action than is strictly necessary, set the
+ # minimal action to RESTART or REPLACE. For
+ # example, Compute Engine does not need to restart a VM to change its
+ # metadata. But if your application reads instance metadata only when a VM
+ # is restarted, you can set the minimal action to RESTART in
+ # order to pick up metadata changes.
+ "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance.
+ # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
+ # as much as possible. RESTART to allow actions that can be
+ # applied without instance replacing or REPLACE to allow all
+ # possible actions. If the Updater determines that the minimal update
+ # action needed is more disruptive than most disruptive allowed action you
+ # specify it will not perform the update at all.
+ "replacementMethod": "A String", # What action should be used to replace instances.
+ # See minimal_action.REPLACE
+ "type": "A String", # The type
+ # of update process. You can specify either PROACTIVE so
+ # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
+ # to update.
+ },
+ "versions": [ # Specifies the instance templates used by this managed instance group to
+ # create instances.
+ #
+ # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
+ # group. This field overrides the top-level instanceTemplate
+ # field. Read more about therelationships
+ # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
+ # remaining instances. For more information, read aboutcanary
+ # updates.
+ {
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
+ # instance group. The group uses this template to create new instances in
+ # the managed instance group until the `targetSize` for this version is
+ # reached. The templates for existing instances in the group do not change
+ # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases,
+ # existing instances are updated until the `targetSize` for this version is
+ # reached.
+ "name": "A String", # Name of the version. Unique among all versions in the scope of this
+ # managed instance group.
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version
+ # even if instance_template remains unchanged.
+ # Deprecated in favor of 'name'.
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
+ # from the template will be equal to:
+ #
+ #
+ # - If expressed as a fixed number, the minimum of either
+ # targetSize.fixed or
+ # instanceGroupManager.targetSize is used.
+ # - if expressed as a percent, the targetSize
+ # would be (targetSize.percent/100 *
+ # InstanceGroupManager.targetSize) If there is a remainder, the
+ # number is rounded.
+ #
+ # If unset, this version will update any remaining instances not
+ # updated by another version. ReadStarting
+ # a canary update for more information.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ },
+ ],
+ "zone": "A String", # Output only. [Output Only] The URL of azone
+ # where the managed instance group is located (for zonal resources).
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -19984,6 +20658,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instanceGroups.html b/docs/dyn/compute_alpha.instanceGroups.html
index 2c4b6dd..2dcc19a 100644
--- a/docs/dyn/compute_alpha.instanceGroups.html
+++ b/docs/dyn/compute_alpha.instanceGroups.html
@@ -295,6 +295,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -843,6 +855,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1274,6 +1298,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1971,6 +2007,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2273,6 +2321,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instanceSettings.html b/docs/dyn/compute_alpha.instanceSettings.html
index 0e090a4..35a345a 100644
--- a/docs/dyn/compute_alpha.instanceSettings.html
+++ b/docs/dyn/compute_alpha.instanceSettings.html
@@ -328,6 +328,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html
index 75fef16..21b07b1 100644
--- a/docs/dyn/compute_alpha.instanceTemplates.html
+++ b/docs/dyn/compute_alpha.instanceTemplates.html
@@ -1615,6 +1615,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4583,6 +4595,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html
index 5ab6f43..421fd8e 100644
--- a/docs/dyn/compute_alpha.instances.html
+++ b/docs/dyn/compute_alpha.instances.html
@@ -478,6 +478,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -974,6 +986,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1267,6 +1291,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2541,6 +2577,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -3711,6 +3748,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5660,6 +5709,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5949,6 +6010,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6233,6 +6306,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6521,6 +6606,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6805,6 +6902,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7982,6 +8091,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -11169,6 +11279,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -11772,6 +11883,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -13035,6 +13158,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -14043,6 +14167,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -14325,6 +14461,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -14616,6 +14764,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -14912,6 +15072,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -15196,6 +15368,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -15612,6 +15796,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -15910,6 +16106,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -16195,6 +16403,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -17365,6 +17585,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -17666,6 +17898,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -17957,6 +18201,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -18271,6 +18527,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -18563,6 +18831,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -18854,6 +19134,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -19294,6 +19586,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -19593,6 +19897,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -19887,6 +20203,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -20181,6 +20509,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -20475,6 +20815,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -20776,6 +21128,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -21061,6 +21425,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -21345,6 +21721,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -21762,6 +22150,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -22053,6 +22453,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -22345,6 +22757,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -23549,6 +23973,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -24158,6 +24583,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -24495,6 +24932,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -24787,6 +25236,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -25288,6 +25749,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -25585,6 +26058,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -25879,6 +26364,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instantSnapshotGroups.html b/docs/dyn/compute_alpha.instantSnapshotGroups.html
index 1b8f0ae..142bb22 100644
--- a/docs/dyn/compute_alpha.instantSnapshotGroups.html
+++ b/docs/dyn/compute_alpha.instantSnapshotGroups.html
@@ -269,6 +269,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1016,6 +1028,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.instantSnapshots.html b/docs/dyn/compute_alpha.instantSnapshots.html
index 635c718..d4086bf 100644
--- a/docs/dyn/compute_alpha.instantSnapshots.html
+++ b/docs/dyn/compute_alpha.instantSnapshots.html
@@ -577,6 +577,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1441,6 +1453,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2863,6 +2887,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html
index 6440501..b4bb4f1 100644
--- a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html
+++ b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html
@@ -777,6 +777,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1059,6 +1071,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2077,6 +2101,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2749,6 +2785,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html
index 33f1ea2..8dd35a0 100644
--- a/docs/dyn/compute_alpha.interconnectAttachments.html
+++ b/docs/dyn/compute_alpha.interconnectAttachments.html
@@ -857,6 +857,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2291,6 +2303,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3494,6 +3518,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4668,6 +4704,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.interconnectGroups.html b/docs/dyn/compute_alpha.interconnectGroups.html
index fb2d9e9..903de26 100644
--- a/docs/dyn/compute_alpha.interconnectGroups.html
+++ b/docs/dyn/compute_alpha.interconnectGroups.html
@@ -399,6 +399,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -681,6 +693,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1771,6 +1795,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2430,6 +2466,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html
index 10e21c6..ba3b1bc 100644
--- a/docs/dyn/compute_alpha.interconnects.html
+++ b/docs/dyn/compute_alpha.interconnects.html
@@ -280,6 +280,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -691,8 +703,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -1507,8 +1518,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -1670,6 +1680,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2165,8 +2187,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -2511,8 +2532,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -2674,6 +2694,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3836,6 +3868,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.licenses.html b/docs/dyn/compute_alpha.licenses.html
index f813976..a7d6aa1 100644
--- a/docs/dyn/compute_alpha.licenses.html
+++ b/docs/dyn/compute_alpha.licenses.html
@@ -274,6 +274,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1112,6 +1124,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2631,6 +2655,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html
index 072c84c..b0bfc72 100644
--- a/docs/dyn/compute_alpha.machineImages.html
+++ b/docs/dyn/compute_alpha.machineImages.html
@@ -272,6 +272,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4664,6 +4676,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7835,6 +7859,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.networkAttachments.html b/docs/dyn/compute_alpha.networkAttachments.html
index 619d404..dbc401d 100644
--- a/docs/dyn/compute_alpha.networkAttachments.html
+++ b/docs/dyn/compute_alpha.networkAttachments.html
@@ -538,6 +538,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1344,6 +1356,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1917,6 +1941,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.networkEdgeSecurityServices.html b/docs/dyn/compute_alpha.networkEdgeSecurityServices.html
index 07084ac..9a78341 100644
--- a/docs/dyn/compute_alpha.networkEdgeSecurityServices.html
+++ b/docs/dyn/compute_alpha.networkEdgeSecurityServices.html
@@ -493,6 +493,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -862,6 +874,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1182,6 +1206,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.networkEndpointGroups.html b/docs/dyn/compute_alpha.networkEndpointGroups.html
index 7205f96..d223c3a 100644
--- a/docs/dyn/compute_alpha.networkEndpointGroups.html
+++ b/docs/dyn/compute_alpha.networkEndpointGroups.html
@@ -234,6 +234,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -723,6 +737,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1015,6 +1041,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1344,6 +1382,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1486,6 +1536,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1692,6 +1756,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone where
@@ -1705,6 +1783,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -2059,6 +2151,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2287,6 +2391,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html
index 1ce3250..4eee15c 100644
--- a/docs/dyn/compute_alpha.networkFirewallPolicies.html
+++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html
@@ -335,6 +335,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -809,6 +821,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1283,6 +1307,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2271,6 +2307,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2557,6 +2605,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4681,6 +4741,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6131,6 +6203,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6430,6 +6514,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6901,6 +6997,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7372,6 +7480,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7654,6 +7774,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7936,6 +8068,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -8218,6 +8362,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html
index 85ebc0f..404f60b 100644
--- a/docs/dyn/compute_alpha.networks.html
+++ b/docs/dyn/compute_alpha.networks.html
@@ -397,6 +397,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -687,6 +699,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -973,6 +997,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2727,6 +2763,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4030,6 +4078,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4318,6 +4378,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4607,6 +4679,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4888,6 +4972,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5281,6 +5377,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.nodeGroups.html b/docs/dyn/compute_alpha.nodeGroups.html
index bdb6321..8cfa29e 100644
--- a/docs/dyn/compute_alpha.nodeGroups.html
+++ b/docs/dyn/compute_alpha.nodeGroups.html
@@ -301,6 +301,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -881,6 +893,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1172,6 +1196,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2041,6 +2077,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2920,6 +2968,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3212,6 +3272,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4377,6 +4449,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4669,6 +4753,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.nodeTemplates.html b/docs/dyn/compute_alpha.nodeTemplates.html
index 1fc26d7..96c83ce 100644
--- a/docs/dyn/compute_alpha.nodeTemplates.html
+++ b/docs/dyn/compute_alpha.nodeTemplates.html
@@ -544,6 +544,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1363,6 +1375,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.organizationSecurityPolicies.html b/docs/dyn/compute_alpha.organizationSecurityPolicies.html
index 8a13025..2fdaf99 100644
--- a/docs/dyn/compute_alpha.organizationSecurityPolicies.html
+++ b/docs/dyn/compute_alpha.organizationSecurityPolicies.html
@@ -318,6 +318,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1105,6 +1117,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1396,6 +1420,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1680,6 +1716,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4044,6 +4092,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5412,6 +5472,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6450,6 +6522,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7240,6 +7324,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7526,6 +7622,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7812,6 +7920,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html
index a8d91d2..a20ef87 100644
--- a/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html
+++ b/docs/dyn/compute_alpha.organizationSnapshotRecycleBinPolicy.html
@@ -318,6 +318,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.packetMirrorings.html b/docs/dyn/compute_alpha.packetMirrorings.html
index 689e698..3c92474 100644
--- a/docs/dyn/compute_alpha.packetMirrorings.html
+++ b/docs/dyn/compute_alpha.packetMirrorings.html
@@ -570,6 +570,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1080,6 +1092,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1728,6 +1752,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.previewFeatures.html b/docs/dyn/compute_alpha.previewFeatures.html
index d077769..d03e5c9 100644
--- a/docs/dyn/compute_alpha.previewFeatures.html
+++ b/docs/dyn/compute_alpha.previewFeatures.html
@@ -597,6 +597,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.projects.html b/docs/dyn/compute_alpha.projects.html
index 4c2bf5f..3ca24ed 100644
--- a/docs/dyn/compute_alpha.projects.html
+++ b/docs/dyn/compute_alpha.projects.html
@@ -297,6 +297,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -590,6 +602,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -870,6 +894,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1164,6 +1200,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2074,6 +2122,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2378,6 +2438,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2668,6 +2740,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2980,6 +3064,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3269,6 +3365,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3558,6 +3666,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3848,6 +3968,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4145,6 +4277,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html
index 651d2f1..e764f60 100644
--- a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html
+++ b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html
@@ -263,6 +263,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -549,6 +561,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -991,6 +1015,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1569,6 +1605,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1850,6 +1898,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html
index 4d3eabe..a27754e 100644
--- a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html
+++ b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html
@@ -577,6 +577,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -864,6 +876,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1384,6 +1408,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2041,6 +2077,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2324,6 +2372,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.recoverableSnapshots.html b/docs/dyn/compute_alpha.recoverableSnapshots.html
index f549b2f..9c2dab4 100644
--- a/docs/dyn/compute_alpha.recoverableSnapshots.html
+++ b/docs/dyn/compute_alpha.recoverableSnapshots.html
@@ -791,6 +791,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2256,6 +2268,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionAutoscalers.html b/docs/dyn/compute_alpha.regionAutoscalers.html
index 3befef9..994efa2 100644
--- a/docs/dyn/compute_alpha.regionAutoscalers.html
+++ b/docs/dyn/compute_alpha.regionAutoscalers.html
@@ -269,6 +269,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1291,6 +1303,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2450,6 +2474,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3130,6 +3166,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionBackendBuckets.html b/docs/dyn/compute_alpha.regionBackendBuckets.html
index 344c04d8..d2efee1 100644
--- a/docs/dyn/compute_alpha.regionBackendBuckets.html
+++ b/docs/dyn/compute_alpha.regionBackendBuckets.html
@@ -282,6 +282,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1339,6 +1351,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2511,6 +2535,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html
index d105d2f..88ed7e2 100644
--- a/docs/dyn/compute_alpha.regionBackendServices.html
+++ b/docs/dyn/compute_alpha.regionBackendServices.html
@@ -287,6 +287,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -559,6 +571,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -1413,6 +1429,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -2749,6 +2770,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -3603,6 +3628,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -4519,6 +4549,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4877,6 +4919,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -5731,6 +5777,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -6767,6 +6818,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -7621,6 +7676,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -8598,6 +8658,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -9452,6 +9516,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -10368,6 +10437,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -11535,6 +11616,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -11839,6 +11932,10 @@
#
# For usage guidelines, seeUtilization
# balancing mode.
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
+ # the backend.
+ "resourceUri": "A String", # The URI of the resource or system that manages the backend.
+ },
"preference": "A String", # This field indicates whether this backend should be fully utilized before
# sending traffic to backends with default preference. The possible values
# are:
@@ -12693,6 +12790,11 @@
# connections to all healthy endpoints across all zones.
},
},
+ "orchestrationInfo": { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend service.
+ # the backend service.
+ "resourceUri": "A String", # The resource URI of the resource or system that manages the backend
+ # service.
+ },
"outlierDetection": { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
# load balancing pool of each individual proxy instance that processes the
# traffic for the given backend service. If not set, this feature is
@@ -13609,6 +13711,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html
index da2c363..dfe8c27 100644
--- a/docs/dyn/compute_alpha.regionCommitments.html
+++ b/docs/dyn/compute_alpha.regionCommitments.html
@@ -337,6 +337,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -357,6 +358,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -505,7 +509,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -909,6 +913,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1191,6 +1207,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1444,6 +1472,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -1464,6 +1493,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1612,7 +1644,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1897,6 +1929,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -1917,6 +1950,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2065,7 +2101,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2380,6 +2416,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2714,6 +2762,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -2734,6 +2783,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2882,7 +2934,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -3252,6 +3304,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -3272,6 +3325,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -3420,7 +3476,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -3737,6 +3793,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3912,6 +3980,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -3932,6 +4001,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -4080,7 +4152,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -4297,6 +4369,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionCompositeHealthChecks.html b/docs/dyn/compute_alpha.regionCompositeHealthChecks.html
index e839b37..0d7b704 100644
--- a/docs/dyn/compute_alpha.regionCompositeHealthChecks.html
+++ b/docs/dyn/compute_alpha.regionCompositeHealthChecks.html
@@ -513,6 +513,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -714,10 +726,12 @@
"healthSources": [ # Health sources and their corresponding health states.
{
"healthState": "A String", # Health state of the associated HealthSource resource.
- "source": "A String", # URL of the associated HealthSource resource.
+ "source": "A String", # Fully qualified URL of the associated HealthSource resource.
},
],
"healthState": "A String", # Health state of the CompositeHealthCheck.
+ "kind": "compute#compositeHealthCheckHealth", # Output only. [Output Only] Type of resource. Alwayscompute#compositeHealthCheckHealth for the health of
+ # composite health checks.
}</pre>
</div>
@@ -929,6 +943,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1454,6 +1480,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionDiskSettings.html b/docs/dyn/compute_alpha.regionDiskSettings.html
index 1d54f50..c33e91e 100644
--- a/docs/dyn/compute_alpha.regionDiskSettings.html
+++ b/docs/dyn/compute_alpha.regionDiskSettings.html
@@ -378,6 +378,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html
index 9a74649..b791ac8 100644
--- a/docs/dyn/compute_alpha.regionDisks.html
+++ b/docs/dyn/compute_alpha.regionDisks.html
@@ -314,6 +314,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -642,6 +654,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1269,6 +1293,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1555,6 +1591,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3530,6 +3578,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4590,6 +4650,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4879,6 +4951,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6051,6 +6135,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6362,6 +6458,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6645,6 +6753,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6948,6 +7068,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7888,6 +8020,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -8171,6 +8315,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -8461,6 +8617,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html b/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html
index 0ae3243..4dc684e 100644
--- a/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html
+++ b/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html
@@ -526,6 +526,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -946,6 +958,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1504,6 +1528,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionHealthCheckServices.html b/docs/dyn/compute_alpha.regionHealthCheckServices.html
index bb02bf1..d8fbc26 100644
--- a/docs/dyn/compute_alpha.regionHealthCheckServices.html
+++ b/docs/dyn/compute_alpha.regionHealthCheckServices.html
@@ -544,6 +544,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -999,6 +1011,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1592,6 +1616,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionHealthChecks.html b/docs/dyn/compute_alpha.regionHealthChecks.html
index a5ae668..33834b4 100644
--- a/docs/dyn/compute_alpha.regionHealthChecks.html
+++ b/docs/dyn/compute_alpha.regionHealthChecks.html
@@ -269,6 +269,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1293,6 +1305,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2454,6 +2478,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3135,6 +3171,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionHealthSources.html b/docs/dyn/compute_alpha.regionHealthSources.html
index 8b26587..b9e722c 100644
--- a/docs/dyn/compute_alpha.regionHealthSources.html
+++ b/docs/dyn/compute_alpha.regionHealthSources.html
@@ -90,6 +90,9 @@
<code><a href="#get">get(project, region, healthSource, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the specified HealthSource resource in the given region.</p>
<p class="toc_element">
+ <code><a href="#getHealth">getHealth(project, region, healthSource, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the most recent health check results for this</p>
+<p class="toc_element">
<code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a HealthSource in the specified project in the given region</p>
<p class="toc_element">
@@ -513,6 +516,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -697,6 +712,49 @@
</div>
<div class="method">
+ <code class="details" id="getHealth">getHealth(project, region, healthSource, x__xgafv=None)</code>
+ <pre>Gets the most recent health check results for this
+regional HealthSource.
+
+Args:
+ project: string, Name of the project scoping this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ healthSource: string, Name of the HealthSource resource to get health for. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for RegionHealthSources.GetHealth
+ "healthState": "A String", # Health state of the HealthSource.
+ "kind": "compute#healthSourceHealth", # Output only. [Output Only] Type of resource. Alwayscompute#healthSourceHealth for the health of health sources.
+ "sources": [ # Health state details of the sources.
+ {
+ "backends": [ # Represents an instance group or network endpoint group behind the source
+ # backend service. Only used if the sourceType of the regionHealthSource
+ # is BACKEND_SERVICE.
+ {
+ "endpointCount": 42, # Total number of endpoints when determining the health of the
+ # regionHealthSource.
+ "group": "A String", # Fully qualified URL of an instance group or network endpoint group
+ # behind the source backend service.
+ "healthyEndpointCount": 42, # Number of endpoints considered healthy when determining health of the
+ # regionHealthSource.
+ },
+ ],
+ "forwardingRule": "A String", # Fully qualified URL of the forwarding rule associated with the source
+ # resource if it is a L4ILB backend service.
+ "source": "A String", # Fully qualified URL of the associated source resource. This is always a
+ # backend service URL.
+ },
+ ],
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
<pre>Create a HealthSource in the specified project in the given region
using the parameters that are included in the request.
@@ -907,6 +965,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1438,6 +1508,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html
index d4761f0..cc4100f 100644
--- a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html
+++ b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html
@@ -265,6 +265,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -558,6 +570,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1591,6 +1615,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
index 97413d4..b252820 100644
--- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
@@ -360,6 +360,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -724,6 +736,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -859,6 +883,7 @@
"allInstances": True or False, # Flag to update all instances instead of specified list of “instances”.
# If the flag is set to true then the instances may not be specified
# in the request.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instances": [ # The list of URLs of one or more instances for which you want to apply
# updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].
"A String",
@@ -1041,6 +1066,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1409,6 +1446,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1692,6 +1741,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2005,6 +2066,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2285,6 +2358,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2560,6 +2645,8 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
"starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
@@ -4104,6 +4191,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -4421,6 +4509,8 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
"starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
@@ -5965,6 +6055,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -6278,6 +6369,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6639,6 +6742,8 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
"starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
@@ -8183,6 +8288,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -10348,5648 +10454,7 @@
# pools for the instance.
"restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
- "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be resumed or are currently being resumed.
- "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be started or are currently being started.
- "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be stopped or are currently being stopped.
- "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be suspended or are currently being suspended.
- "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are being verified. See the managedInstances[].currentAction
- # property in the listManagedInstances method documentation.
- },
- "description": "A String", # An optional description of this resource.
- "distributionPolicy": { # Policy specifying the intended distribution of managed instances across
- # zones in a regional managed instance group.
- "targetShape": "A String", # The distribution shape to which the group converges either proactively or
- # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
- "zones": [ # Zones where the regional managed instance group will create and manage
- # its instances.
- {
- "zone": "A String", # The URL of thezone.
- # The zone must exist in the region where the managed instance group is
- # located.
- },
- ],
- },
- "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER.
- "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking.
- # It will be ignored when inserting an InstanceGroupManager. An up-to-date
- # fingerprint must be provided in order to update the InstanceGroupManager,
- # otherwise the request will fail with error412 conditionNotMet.
- #
- # To see the latest fingerprint, make a get() request to
- # retrieve an InstanceGroupManager.
- "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
- # generates this identifier.
- "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple
- # types of machines.
- # Instance flexibility configuration on MIG overrides instance
- # template configuration.
- "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
- # when creating new VMs.
- "a_key": {
- "disks": [ # List of disks to be attached to the instances created from this
- # selection.
- { # An instance-attached disk resource.
- "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
- # or X86_64.
- "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
- # deleted (but not when the disk is detached from the instance).
- "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
- # partition of the disk for its root filesystem.
- "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
- # running within the instance. This name can be used to reference the device
- # for mounting, resizing, and so on, from within the instance.
- #
- # If not specified, the server chooses a default device name to apply to this
- # disk, in the form persistent-disk-x, where x is a number
- # assigned by Google Compute Engine. This field is only applicable for
- # persistent disks.
- "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
- # encryption key.
- #
- # If you are creating a new disk, this field encrypts the new disk using
- # an encryption key that you provide. If you are attaching an existing
- # disk that is already encrypted, this field decrypts the disk using
- # the customer-supplied encryption key.
- #
- # If you encrypt a disk using a customer-supplied key, you must provide the
- # same key again when you attempt to use this resource at a later time. For
- # example, you must provide the key when you create a snapshot or an image
- # from the disk or when you attach the disk to a virtual machine instance.
- #
- # If you do not provide an encryption key, then the disk will be encrypted
- # using an automatically generated key and you do not need to provide a key
- # to use the disk later.
- #
- # Note:
- #
- # Instance templates do not storecustomer-supplied
- # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
- #
- # You cannot create VMs that have disks with customer-supplied keys using
- # the bulk
- # insert method.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "diskSizeGb": "A String", # The size of the disk in GB.
- "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
- # currently attached to another instance. If you try to force attach a zonal
- # disk to an instance, you will receive an error.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
- # boot disk. If you have many disks attached to an instance, each
- # disk would have a unique index number.
- "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This field is persisted and returned for instanceTemplate and not returned
- # in the context of instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- "architecture": "A String", # The architecture of the attached disk. Valid values are
- # arm64 or x86_64.
- "description": "A String", # An optional description. Provide this property when creating the disk.
- "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
- # of the instance. If a disk with the same name already exists in the given
- # region, the existing disk is attached to the new instance and the
- # new disk is not created.
- "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
- # 10 GB. If you specify a sourceImage, which is required for
- # boot disks, the default size is the size of the sourceImage.
- # If you do not specify a sourceImage, the default disk size
- # is 500 GB.
- "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
- # the default is pd-standard, specified using the full URL.
- # For example:
- #
- # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
- #
- #
- # For a full list of acceptable values, seePersistent disk
- # types. If you specify this field when creating a VM, you can provide
- # either the full or partial URL. For example, the following values are
- # valid:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
- # - projects/project/zones/zone/diskTypes/diskType
- # - zones/zone/diskTypes/diskType
- #
- #
- # If you specify this field when creating or updating an instance template
- # or all-instances configuration, specify the type of the disk, not the
- # URL. For example: pd-standard.
- "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- #
- # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
- # which is either SCSI or NVME. The default isSCSI.
- "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
- # persistent disks.
- "a_key": "A String",
- },
- "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
- # disk.
- "A String",
- ],
- "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
- "A String",
- ],
- "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
- # more than one instance.
- "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
- # is to use the existing disk.
- "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
- # of I/O operations per second that the disk can handle. Values must be
- # between 10,000 and 120,000. For more details, see theExtreme persistent
- # disk documentation.
- "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
- # number of throughput mb per second that the disk can handle. Values must
- # greater than or equal to 1.
- "replicaZones": [ # Required for each regional disk associated with the instance. Specify
- # the URLs of the zones where the disk should be replicated to.
- # You must provide exactly two replica zones, and one zone must be the same
- # as the instance zone.
- "A String",
- ],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
- # have the same definition as resource
- # manager tags. Keys and values can be either in numeric format,
- # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
- # format such as `{org_id|project_id}/{tag_key_short_name}` and
- # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
- # empty.
- "a_key": "A String",
- },
- "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
- # Specified using the full or partial URL. For instance template, specify
- # only the resource policy name.
- "A String",
- ],
- "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
- # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # To create a disk with one of the public operating system
- # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
- #
- # projects/debian-cloud/global/images/family/debian-9
- #
- #
- # Alternatively, use a specific version of a public operating system image:
- #
- # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
- #
- #
- # To create a disk with a custom image that you created, specify the
- # image name in the following format:
- #
- # global/images/my-custom-image
- #
- #
- # You can also specify a custom image by its image family, which returns
- # the latest version of the image in that family. Replace the image name
- # with family/family-name:
- #
- # global/images/family/my-image-family
- #
- #
- # If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source image. Required if the source image is
- # protected by a customer-supplied encryption key.
- #
- # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
- # encryption keys, so you cannot create disks for instances in a managed instance group if the
- # source images are encrypted with your own keys.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
- # instance boot disk, one of initializeParams.sourceSnapshot
- # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # us-central1-a/instantSnapshots/my-backup
- #
- #
- # If the source instant-snapshot is deleted later, this field will not be
- # set.
- "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
- # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # global/snapshots/my-backup
- #
- #
- # If the source snapshot is deleted later, this field will not be set.
- #
- # Note: You cannot create VMs in bulk using a snapshot as the source. Use
- # an image instead when you create VMs using
- # the bulk
- # insert method.
- "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source snapshot.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
- # this as a partial or full URL to the resource. For example, the following
- # are valid values:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
- # - projects/project/zones/zone/storagePools/storagePool
- # - zones/zone/storagePools/storagePool
- },
- "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
- # either SCSI or NVME. For most machine types, the
- # default is SCSI. Local SSDs can use either NVME or SCSI.
- # In certain configurations, persistent disks can use NVMe. For more
- # information, seeAbout
- # persistent disks.
- "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
- "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
- "A String",
- ],
- "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
- # disk is not allowed to be detached from the instance, or to be used as the
- # source of the snapshot creation, and the image creation. The instance with
- # at least one locked attached disk is not allow to be used as source of
- # machine image creation, instant snapshot creation, and not allowed to be
- # deleted with --keep-disk parameter set to true for locked disks.
- "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
- # in READ_WRITE mode.
- "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
- # field is set to PRESERVED if the LocalSSD data has been saved
- # to a persistent location by customer request. (see the
- # discard_local_ssd option on Stop/Suspend).
- # Read-only in the api.
- "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
- # these are public keys which are safe to store in public
- "dbs": [ # The Key Database (db).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "dbxs": [ # The forbidden key database (dbx).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "keks": [ # The Key Exchange Key (KEK).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "pk": { # The Platform Key (PK).
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- },
- "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
- # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # If desired, you can also attach existing non-root persistent disks using
- # this property. This field is only applicable for persistent disks.
- #
- # Note that for InstanceTemplate, specify the disk name for zonal disk,
- # and the URL for regional disk.
- "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
- },
- ],
- "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
- "A String",
- ],
- "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
- # e.g. 'Intel Ice Lake'.
- "rank": 42, # Preference of this instance selection. Lower number means higher
- # preference. MIG will first try to create a VM based on the machine-type
- # with lowest rank and fallback to next rank based on availability.
- # Machine types and instance selections with the same rank have the same
- # preference.
- },
- },
- "instanceSelections": { # Named instance selections configuring properties that the group will use
- # when creating new VMs.
- "a_key": {
- "disks": [ # List of disks to be attached to the instances created from this
- # selection.
- { # An instance-attached disk resource.
- "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
- # or X86_64.
- "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
- # deleted (but not when the disk is detached from the instance).
- "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
- # partition of the disk for its root filesystem.
- "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
- # running within the instance. This name can be used to reference the device
- # for mounting, resizing, and so on, from within the instance.
- #
- # If not specified, the server chooses a default device name to apply to this
- # disk, in the form persistent-disk-x, where x is a number
- # assigned by Google Compute Engine. This field is only applicable for
- # persistent disks.
- "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
- # encryption key.
- #
- # If you are creating a new disk, this field encrypts the new disk using
- # an encryption key that you provide. If you are attaching an existing
- # disk that is already encrypted, this field decrypts the disk using
- # the customer-supplied encryption key.
- #
- # If you encrypt a disk using a customer-supplied key, you must provide the
- # same key again when you attempt to use this resource at a later time. For
- # example, you must provide the key when you create a snapshot or an image
- # from the disk or when you attach the disk to a virtual machine instance.
- #
- # If you do not provide an encryption key, then the disk will be encrypted
- # using an automatically generated key and you do not need to provide a key
- # to use the disk later.
- #
- # Note:
- #
- # Instance templates do not storecustomer-supplied
- # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
- #
- # You cannot create VMs that have disks with customer-supplied keys using
- # the bulk
- # insert method.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "diskSizeGb": "A String", # The size of the disk in GB.
- "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
- # currently attached to another instance. If you try to force attach a zonal
- # disk to an instance, you will receive an error.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
- # boot disk. If you have many disks attached to an instance, each
- # disk would have a unique index number.
- "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- # alongside the new instance. Use initialization parameters to create boot
- # disks or local SSDs attached to the new instance.
- #
- # This field is persisted and returned for instanceTemplate and not returned
- # in the context of instance.
- #
- # This property is mutually exclusive with the source property;
- # you can only define one or the other, but not both.
- "architecture": "A String", # The architecture of the attached disk. Valid values are
- # arm64 or x86_64.
- "description": "A String", # An optional description. Provide this property when creating the disk.
- "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
- # of the instance. If a disk with the same name already exists in the given
- # region, the existing disk is attached to the new instance and the
- # new disk is not created.
- "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
- # 10 GB. If you specify a sourceImage, which is required for
- # boot disks, the default size is the size of the sourceImage.
- # If you do not specify a sourceImage, the default disk size
- # is 500 GB.
- "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
- # the default is pd-standard, specified using the full URL.
- # For example:
- #
- # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
- #
- #
- # For a full list of acceptable values, seePersistent disk
- # types. If you specify this field when creating a VM, you can provide
- # either the full or partial URL. For example, the following values are
- # valid:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
- # - projects/project/zones/zone/diskTypes/diskType
- # - zones/zone/diskTypes/diskType
- #
- #
- # If you specify this field when creating or updating an instance template
- # or all-instances configuration, specify the type of the disk, not the
- # URL. For example: pd-standard.
- "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
- "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
- # only for bootable images. Read
- # Enabling guest operating system features to see a list of available
- # options.
- #
- # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
- { # Guest OS features.
- "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
- # separate values. Set to one or more of the following values:
- #
- # - VIRTIO_SCSI_MULTIQUEUE
- # - WINDOWS
- # - MULTI_IP_SUBNET
- # - UEFI_COMPATIBLE
- # - GVNIC
- # - SEV_CAPABLE
- # - SUSPEND_RESUME_COMPATIBLE
- # - SEV_LIVE_MIGRATABLE_V2
- # - SEV_SNP_CAPABLE
- # - TDX_CAPABLE
- # - IDPF
- # - SNP_SVSM_CAPABLE
- #
- #
- # For more information, see
- # Enabling guest operating system features.
- },
- ],
- "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
- # which is either SCSI or NVME. The default isSCSI.
- "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
- # persistent disks.
- "a_key": "A String",
- },
- "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
- # disk.
- "A String",
- ],
- "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
- "A String",
- ],
- "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
- # more than one instance.
- "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
- # is to use the existing disk.
- "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
- # of I/O operations per second that the disk can handle. Values must be
- # between 10,000 and 120,000. For more details, see theExtreme persistent
- # disk documentation.
- "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
- # number of throughput mb per second that the disk can handle. Values must
- # greater than or equal to 1.
- "replicaZones": [ # Required for each regional disk associated with the instance. Specify
- # the URLs of the zones where the disk should be replicated to.
- # You must provide exactly two replica zones, and one zone must be the same
- # as the instance zone.
- "A String",
- ],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
- # have the same definition as resource
- # manager tags. Keys and values can be either in numeric format,
- # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
- # format such as `{org_id|project_id}/{tag_key_short_name}` and
- # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
- # empty.
- "a_key": "A String",
- },
- "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
- # Specified using the full or partial URL. For instance template, specify
- # only the resource policy name.
- "A String",
- ],
- "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
- # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # To create a disk with one of the public operating system
- # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
- #
- # projects/debian-cloud/global/images/family/debian-9
- #
- #
- # Alternatively, use a specific version of a public operating system image:
- #
- # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
- #
- #
- # To create a disk with a custom image that you created, specify the
- # image name in the following format:
- #
- # global/images/my-custom-image
- #
- #
- # You can also specify a custom image by its image family, which returns
- # the latest version of the image in that family. Replace the image name
- # with family/family-name:
- #
- # global/images/family/my-image-family
- #
- #
- # If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source image. Required if the source image is
- # protected by a customer-supplied encryption key.
- #
- # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
- # encryption keys, so you cannot create disks for instances in a managed instance group if the
- # source images are encrypted with your own keys.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
- # instance boot disk, one of initializeParams.sourceSnapshot
- # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # us-central1-a/instantSnapshots/my-backup
- #
- #
- # If the source instant-snapshot is deleted later, this field will not be
- # set.
- "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
- # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
- # is required.
- #
- # To create a disk with a snapshot that you created, specify the
- # snapshot name in the following format:
- #
- # global/snapshots/my-backup
- #
- #
- # If the source snapshot is deleted later, this field will not be set.
- #
- # Note: You cannot create VMs in bulk using a snapshot as the source. Use
- # an image instead when you create VMs using
- # the bulk
- # insert method.
- "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
- # encryption key of the source snapshot.
- "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
- # For example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- #
- # The fully-qualifed key name may be returned for resource GET requests. For
- # example:
- #
- # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
- # key_region/cryptoKeys/key
- # /cryptoKeyVersions/1
- "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
- # key. If absent, the Compute Engine default service account is used.
- # For example:
- #
- # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
- "rawKey": "A String", # Specifies a 256-bit customer-supplied
- # encryption key, encoded in RFC
- # 4648 base64 to either encrypt or decrypt this resource. You can
- # provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rawKey":
- # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
- "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
- # customer-supplied encryption key to either encrypt or decrypt this
- # resource. You can provide either the rawKey or thersaEncryptedKey.
- # For example:
- #
- # "rsaEncryptedKey":
- # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
- # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
- # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
- #
- # The key must meet the following requirements before you can provide it to
- # Compute Engine:
- #
- # 1. The key is wrapped using a RSA public key certificate provided by
- # Google.
- # 2. After being wrapped, the key must be encoded in RFC 4648 base64
- # encoding.
- #
- # Gets the RSA public key certificate provided by Google at:
- #
- #
- # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
- "sha256": "A String", # [Output only] TheRFC
- # 4648 base64 encoded SHA-256 hash of the customer-supplied
- # encryption key that protects this resource.
- },
- "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
- # this as a partial or full URL to the resource. For example, the following
- # are valid values:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
- # - projects/project/zones/zone/storagePools/storagePool
- # - zones/zone/storagePools/storagePool
- },
- "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
- # either SCSI or NVME. For most machine types, the
- # default is SCSI. Local SSDs can use either NVME or SCSI.
- # In certain configurations, persistent disks can use NVMe. For more
- # information, seeAbout
- # persistent disks.
- "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
- "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
- "A String",
- ],
- "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
- # disk is not allowed to be detached from the instance, or to be used as the
- # source of the snapshot creation, and the image creation. The instance with
- # at least one locked attached disk is not allow to be used as source of
- # machine image creation, instant snapshot creation, and not allowed to be
- # deleted with --keep-disk parameter set to true for locked disks.
- "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
- # in READ_WRITE mode.
- "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
- # field is set to PRESERVED if the LocalSSD data has been saved
- # to a persistent location by customer request. (see the
- # discard_local_ssd option on Stop/Suspend).
- # Read-only in the api.
- "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
- # these are public keys which are safe to store in public
- "dbs": [ # The Key Database (db).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "dbxs": [ # The forbidden key database (dbx).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "keks": [ # The Key Exchange Key (KEK).
- {
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- ],
- "pk": { # The Platform Key (PK).
- "content": "A String", # The raw content in the secure keys file.
- "fileType": "A String", # The file type of source file.
- },
- },
- "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
- # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
- # is required.
- #
- # If desired, you can also attach existing non-root persistent disks using
- # this property. This field is only applicable for persistent disks.
- #
- # Note that for InstanceTemplate, specify the disk name for zonal disk,
- # and the URL for regional disk.
- "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
- },
- ],
- "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
- "A String",
- ],
- "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
- # e.g. 'Intel Ice Lake'.
- "rank": 42, # Preference of this instance selection. Lower number means higher
- # preference. MIG will first try to create a VM based on the machine-type
- # with lowest rank and fallback to next rank based on availability.
- # Machine types and instance selections with the same rank have the same
- # preference.
- },
- },
- "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to
- # create instances.
- "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of
- # more preemption than the minimum capacity user needs. MIG will create
- # only Standard VMs until it reaches standard_capacity_base and only
- # then will start using standard_capacity_percent_above_base to mix Spot
- # with Standard VMs.
- "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The
- # remaining percentage will use Spot VMs. The percentage applies only to
- # the capacity above standard_capacity_base.
- },
- },
- "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource.
- "instanceLifecyclePolicy": { # The repair policy for this managed instance group.
- "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field
- # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application
- # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed
- # VM by recreating it. For more information, see about repairing VMs in a MIG. - DO_NOTHING: MIG
- # does not repair a failed VM.
- "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest
- # configuration when repairing a VM. Valid options are:
- #
- #
- #
- # - NO (default): If configuration updates are available, they are not
- # forcefully applied during repair. Instead, configuration updates are
- # applied according to the group's update policy.
- #
- # - YES: If configuration updates are available, they are applied
- # during repair.
- "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the
- # instance during initialization when stopping / suspending an instance.
- # The Instance Group Manager will wait for a signal that indicates
- # successful initialization before stopping / suspending an instance.
- #
- # If a successful readiness signal is not sent before timeout, the
- # corresponding instance will not be stopped / suspended. Instead,
- # an error will be visible in the lastAttempt.errors field of
- # the managed instance in the listmanagedinstances
- # method.
- #
- # If metadataBasedReadinessSignal.timeoutSec is unset,
- # the Instance Group Manager will directly proceed to suspend / stop
- # instances, skipping initialization on them.
- "timeoutSec": 42, # The number of seconds to wait for a readiness signal during
- # initialization before timing out.
- },
- "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
- # unhealthy when the application running on that VM fails a health check.
- # Valid values are:
- #
- # - DEFAULT_ACTION (default): MIG uses the same action
- # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
- # - REPAIR: MIG automatically repairs an unhealthy VM by
- # recreating it.
- # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
- # For more information, see
- # About repairing VMs in a MIG.
- "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
- "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
- # Valid values are:
- #
- # - NO (default): MIG cannot change a VM's zone during a
- # repair.
- # - YES: MIG can select a different zone for the VM during
- # a repair.
- },
- },
- "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
- # instance group. The group uses this template to create all new instances
- # in the managed instance group. The templates for existing instances in the
- # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
- "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
- "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for
- # this managed instance group.
- "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to.
- "name": "A String", # The name of the managed instance group. The name must be 1-63 characters
- # long, and comply withRFC1035.
- "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary
- # to this Instance Group Manager.
- { # The named port. For example: <"http", 80>.
- "name": "A String", # The name for this named port.
- # The name must be 1-63 characters long, and comply withRFC1035.
- "port": 42, # The port number, which can be a value between 1 and 65535.
- },
- ],
- "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
- # as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
- # key-value pairs. Keys and values can be either in numeric format,
- # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
- # format such as `{org_id|project_id}/{tag_key_short_name}` and
- # `{tag_value_short_name}`. For more information, seeManage tags
- # for resources.
- "a_key": "A String",
- },
- },
- "region": "A String", # Output only. [Output Only] The URL of theregion
- # where the managed instance group resides (for regional resources).
- "resourcePolicies": { # Resource policies for this managed instance group.
- "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed
- # instance group.
- # It can be a full or partial URL. For example, the following are
- # all valid URLs to a workload policy:
- #
- #
- # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
- # - projects/project/regions/region/resourcePolicies/resourcePolicy
- # - regions/region/resourcePolicies/resourcePolicy
- },
- "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
- "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
- "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines
- # this URL.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "serviceAccount": "A String", # The service account to be used as credentials for all operations performed
- # by the managed instance group on instances. The service accounts needs all
- # permissions required to create and delete instances.
- # By default, the service account
- # {projectNumber}@cloudservices.gserviceaccount.com is used.
- "standbyPolicy": { # Standby policy for stopped and suspended instances.
- "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or
- # stop a VM after that VM was created. The initial delay gives the
- # initialization script the time to prepare your VM for a quick scale out.
- # The value of initial delay must be between 0 and 3600 seconds. The
- # default value is 0.
- "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the
- # group scales out. The default mode is `MANUAL`.
- },
- "statefulPolicy": { # Stateful configuration for this Instanced Group Manager
- "preservedState": { # Configuration of preserved resources.
- "disks": { # Disks created on the instances that will be preserved on instance
- # delete, update, etc. This map is keyed with the device names of
- # the disks.
- "a_key": {
- "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the disk should be deleted after it
- # is no longer used by the group, e.g. when the given instance or
- # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
- },
- },
- "externalIPs": { # External network IPs assigned to the instances that will be preserved on
- # instance delete, update, etc. This map is keyed with the network
- # interface name.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- },
- },
- "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on
- # instance delete, update, etc. This map is keyed with the network
- # interface name.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- },
- },
- },
- },
- "status": { # Output only. [Output Only] The status of this managed instance group.
- "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group.
- "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision.
- # This value is in RFC3339 text format.
- "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has
- # been applied to all managed instances in the group.
- },
- "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG.
- # Currently only one accelerator topology is supported.
- {
- "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc.
- # The value is the same as configured in the WorkloadPolicy.
- "state": "A String", # Output only. [Output Only] The state of the accelerator topology.
- "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state
- # check.
- "error": { # Output only. [Output Only] Encountered errors.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field
- # has // RFC3339 //
- # text format.
- },
- },
- ],
- "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler
- # that targets this instance group manager.
- "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation.
- # targetSizePolicy.mode is set to BULK.
- "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress.
- "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance
- # operation.
- "error": { # Output only. [Output Only] Errors encountered during bulk instance operation.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance
- # operation. Timestamp is in RFC3339 text format.
- },
- },
- "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
- # in this managed instance group that have the status. Currently only shown
- # for TPU MIGs
- # instance group that have the status. For more information about how to
- # interpret each status check the instance lifecycle documentation.
- # Currently only shown for TPU MIGs.
- "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have DEPROVISIONING status.
- "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
- # have been deleted. Includes only instances that would be shown in the
- # listManagedInstances method and not all instances that have been
- # deleted in the lifetime of the MIG.
- # Does not include FlexStart instances that are waiting for the resources
- # availability, they are considered as 'pending'.
- "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have PENDING status, that is FlexStart instances that are waiting
- # for resources. Instances that do not exist because of the other reasons
- # are counted as 'non_existent'.
- "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have PENDING_STOP status.
- "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have PROVISIONING status.
- "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have REPAIRING status.
- "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have RUNNING status.
- "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have STAGING status.
- "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have STOPPED status.
- "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have STOPPING status.
- "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have SUSPENDED status.
- "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have SUSPENDING status.
- "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
- # that have TERMINATED status.
- },
- "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
- # stable state. A stable state means that: none of the instances in the
- # managed instance group is currently undergoing any type of change (for
- # example, creation, restart, or deletion); no future changes are scheduled
- # for instances in the managed instance group; and the managed instance
- # group itself is not being modified.
- "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager.
- "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
- # has stateful configuration, that is, if you have configured any items
- # in a stateful policy or in per-instance configs.
- # The group might report that it has no stateful configuration even when
- # there is still some preserved state on a managed instance, for example,
- # if you have deleted all PICs but not yet applied those deletions.
- "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
- # has stateful configuration, that is, if you have configured any items
- # in a stateful policy or in per-instance configs.
- # The group might report that it has no stateful configuration even when
- # there is still some preserved state on a managed instance, for example,
- # if you have deleted all PICs but not yet applied those deletions. This
- # field is deprecated in favor of has_stateful_config.
- "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances.
- "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations
- # (listed in the output of a listPerInstanceConfigs API call) have
- # status EFFECTIVE or there are no per-instance-configs.
- },
- },
- "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their
- # target version specified by version field on Instance Group
- # Manager.
- "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached
- # in this managed instance group, i.e. all instances are in their target
- # version. Instances' target version are specified byversion field on Instance Group Manager.
- },
- },
- "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
- # apply to all of the instances in the managed instance group.
- "A String",
- ],
- "targetSize": 42, # The target number of running instances for this managed instance group.
- # You can reduce this number by using the instanceGroupManager
- # deleteInstances or abandonInstances methods. Resizing the group also
- # changes this number.
- "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target
- # size.
- "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs
- # individually or all at once.
- },
- "targetSizeUnit": "A String", # The unit of measure for the target size.
- "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group.
- # This number changes when you:
- #
- # - Stop instance using the stopInstances
- # method or start instances using the startInstances
- # method.
- # - Manually change the targetStoppedSize using the update
- # method.
- "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group.
- # This number changes when you:
- #
- # - Suspend instance using the suspendInstances
- # method or resume instances using the resumeInstances
- # method.
- # - Manually change the targetSuspendedSize using the update
- # method.
- "updatePolicy": { # The update policy for this managed instance group.
- "instanceRedistributionType": "A String", # The
- # instance redistribution policy for regional managed instance groups.
- # Valid values are:
- #
- # - PROACTIVE (default): The group attempts to maintain an
- # even distribution of VM instances across zones in the region.
- # - NONE: For non-autoscaled groups, proactive
- # redistribution is disabled.
- "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
- # either a fixed number or, if the group has 10 or more instances, a
- # percentage. If you set a percentage, the number of instances is rounded
- # if necessary. The default value for maxSurge is a fixed
- # value equal to the number of zones in which the managed instance group
- # operates.
- #
- # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
- # process. An instance is considered available if all of the following
- # conditions are satisfied:
- #
- #
- #
- # - The instance's status is
- # RUNNING.
- # - If there is a health
- # check on the instance group, the instance's health check status
- # must be HEALTHY at least once. If there is no health check
- # on the group, then the instance only needs to have a status of
- # RUNNING to be considered available.
- #
- #
- # This value can be either a fixed number or, if the group has 10 or more
- # instances, a percentage. If you set a percentage, the number of instances
- # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
- # in which the managed instance group operates.
- #
- # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance
- # becomes available. This value must be from range [0, 3600].
- "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize
- # disruption as much as possible or to apply a more disruptive action than
- # is necessary.
- #
- # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
- # Compute Engine performs the necessary action to execute the update.
- # - To apply a more disruptive action than is strictly necessary, set the
- # minimal action to RESTART or REPLACE. For
- # example, Compute Engine does not need to restart a VM to change its
- # metadata. But if your application reads instance metadata only when a VM
- # is restarted, you can set the minimal action to RESTART in
- # order to pick up metadata changes.
- "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance.
- # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
- # as much as possible. RESTART to allow actions that can be
- # applied without instance replacing or REPLACE to allow all
- # possible actions. If the Updater determines that the minimal update
- # action needed is more disruptive than most disruptive allowed action you
- # specify it will not perform the update at all.
- "replacementMethod": "A String", # What action should be used to replace instances.
- # See minimal_action.REPLACE
- "type": "A String", # The type
- # of update process. You can specify either PROACTIVE so
- # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
- # to update.
- },
- "versions": [ # Specifies the instance templates used by this managed instance group to
- # create instances.
- #
- # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
- # group. This field overrides the top-level instanceTemplate
- # field. Read more about therelationships
- # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
- # remaining instances. For more information, read aboutcanary
- # updates.
- {
- "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
- # instance group. The group uses this template to create new instances in
- # the managed instance group until the `targetSize` for this version is
- # reached. The templates for existing instances in the group do not change
- # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases,
- # existing instances are updated until the `targetSize` for this version is
- # reached.
- "name": "A String", # Name of the version. Unique among all versions in the scope of this
- # managed instance group.
- "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version
- # even if instance_template remains unchanged.
- # Deprecated in favor of 'name'.
- "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
- # from the template will be equal to:
- #
- #
- # - If expressed as a fixed number, the minimum of either
- # targetSize.fixed or
- # instanceGroupManager.targetSize is used.
- # - if expressed as a percent, the targetSize
- # would be (targetSize.percent/100 *
- # InstanceGroupManager.targetSize) If there is a remainder, the
- # number is rounded.
- #
- # If unset, this version will update any remaining instances not
- # updated by another version. ReadStarting
- # a canary update for more information.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- },
- ],
- "zone": "A String", # Output only. [Output Only] The URL of azone
- # where the managed instance group is located (for zonal resources).
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Inserts or patches per-instance configurations for the managed instance
-group. perInstanceConfig.name serves as a key used to
-distinguish whether to perform insert or patch.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request, should conform to RFC1035. (required)
- instanceGroupManager: string, The name of the managed instance group.
-It should conform to RFC1035. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # RegionInstanceGroupManagers.patchPerInstanceConfigs
- "perInstanceConfigs": [ # The list of per-instance configurations to insert or patch on this managed
- # instance group.
- {
- "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in
- # optimistic locking. It is ignored when inserting a per-instance
- # config. An up-to-date fingerprint must be provided in order to update an
- # existing per-instance configuration or the field needs to be unset.
- "name": "A String", # The name of a per-instance configuration and its corresponding instance.
- # Serves as a merge key during UpdatePerInstanceConfigs
- # operations, that is, if a per-instance configuration with the same name
- # exists then it will be updated, otherwise a new one will be created for the
- # VM instance with the same name. An attempt to create a per-instance
- # configuration for a VM instance that either doesn't exist or is not part
- # of the group will result in an error.
- "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
- # preserved state generated from a stateful policy.
- "disks": { # Preserved disks defined for this instance.
- # This map is keyed with the device names of the disks.
- "a_key": {
- "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
- # update, instance recreate operations. This flag is used to configure
- # if the disk should be deleted after it is no longer used by the group,
- # e.g. when the given instance or the whole MIG is deleted.
- # Note: disks attached in READ_ONLY mode cannot be
- # auto-deleted.
- "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
- # disk in READ_WRITE mode.
- "source": "A String", # The URL of the disk resource that is stateful and should be attached
- # to the VM instance.
- },
- },
- "externalIPs": { # Preserved external IPs defined for this instance.
- # This map is keyed with the name of the network interface.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- "ipAddress": { # Ip address representation
- "address": "A String", # The URL of the reservation for this IP address.
- "literal": "A String", # An IPv4 internal network address to assign to the instance for this
- # network interface.
- },
- },
- },
- "internalIPs": { # Preserved internal IPs defined for this instance.
- # This map is keyed with the name of the network interface.
- "a_key": {
- "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
- # update or VM instance recreate operations.
- # This flag is used to configure if the IP reservation should be deleted
- # after it is no longer used by the group, e.g. when the given instance
- # or the whole group is deleted.
- "ipAddress": { # Ip address representation
- "address": "A String", # The URL of the reservation for this IP address.
- "literal": "A String", # An IPv4 internal network address to assign to the instance for this
- # network interface.
- },
- },
- },
- "metadata": { # Preserved metadata defined for this instance.
- "a_key": "A String",
- },
- },
- "status": "A String", # The status of applying this per-instance configuration on the corresponding
- # managed instance.
- },
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified VM instances in the managed instance group to be
-immediately recreated. Each instance is recreated using the group's current
-configuration. This operation is marked as DONE when the flag
-is set even if the instances have not yet been recreated. You must
-separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking
-the status of managed instances.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is removed or deleted.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, Name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instances": [ # The URLs of one or more instances to recreate. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</code>
- <pre>Changes the intended size of the managed instance group. If you increase
-the size, the group creates new instances using the current instance
-template. If you decrease the size, the group deletes one or more
-instances.
-
-The resize operation is marked DONE if theresize request is successful. The underlying actions take
-additional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances
-method.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is removed or deleted.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, Name of the managed instance group. (required)
- size: integer, Number of instances that should exist in this instance group
-manager. (required)
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="resizeAdvanced">resizeAdvanced(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Resizes the regional managed instance group with advanced configuration
-options like disabling creation retries. This is an extended version of theresize method.
-
-If you increase the size, the group creates new instances using the current
-instance template. If you decrease the size, the group deletes one or more
-instances.
-
-The resize operation is marked DONE if theresize request is successful. The underlying actions take
-additional time. You must separately verify the status of thecreating or deleting actions with the get
-orlistmanagedinstances
-method.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is removed or deleted.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request.
-It must be a string that meets the requirements in RFC1035. (required)
- instanceGroupManager: string, The name of the managed instance group.
-It must be a string that meets the requirements in RFC1035. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all
- # instances initiated by this resize request only once. If there is an error
- # during creation, the managed instance group does not retry create this
- # instance, and we will decrease the targetSize of the request
- # instead. If the flag is false, the group attempts to recreate each instance
- # continuously until it succeeds.
- #
- # This flag matters only in the first attempt of creation of an instance.
- # After an instance is successfully created while this flag is enabled, the
- # instance behaves the same way as all the other instances created with a
- # regular resize request. In particular, if a running instance dies
- # unexpectedly at a later time and needs to be recreated, this mode does not
- # affect the recreation behavior in that scenario.
- #
- # This flag is applicable only to the current resize request. It does not
- # influence other resize requests in any way.
- #
- # You can see which instances ar being created in which mode by calling
- # the get or listManagedInstances API.
- "targetSize": 42, # The number of running instances that the managed instance group should
- # maintain at any given time. The group automatically adds or removes
- # instances to maintain the number of instances specified by this parameter.
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="resumeInstances">resumeInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-resumed. This method increases thetargetSize and decreases the targetSuspendedSize
-of the managed instance group by the number of instances that you resume.
-The resumeInstances operation is marked DONE if
-the resumeInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances
-method.
-
-In this request, you can only specify instances that are suspended. For
-example, if an instance was previously suspended using the suspendInstances
-method, it can be resumed using the resumeInstances method.
-
-If a health check is attached to the managed instance group, the specified
-instances will be verified as healthy after they are resumed.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, Name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instances": [ # The URLs of one or more instances to resume. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Modifies the autohealing policy for the instances in this managed
-instance group.
-[Deprecated] This method is deprecated. UseregionInstanceGroupManagers.patch instead.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, Name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "autoHealingPolicies": [
- {
- "autoHealingTriggers": { # Restricts what triggers autohealing.
- "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
- # this field controls whether to trigger VM autohealing based on a failed
- # health check. Valid values are:
- #
- # - ON (default): The group recreates running VMs that
- # fail the application-based health check.
- # - OFF: When set to OFF, you can still observe instance
- # health state, but the group does not recreate VMs that fail the
- # application-based health check. This is useful for troubleshooting and
- # setting up your health check configuration.
- },
- "healthCheck": "A String", # The URL for the health check that signals autohealing.
- "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
- # initialize and run its startup script. During a VM's initial delay
- # period, the MIG ignores unsuccessful health checks because the VM might
- # be in the startup process. This prevents the MIG from prematurely
- # recreating a VM. If the health check receives a healthy response during
- # the initial delay, it indicates that the startup process is complete and
- # the VM is ready. The value of initial delay must be between 0 and 3600
- # seconds. The default value is 0.
- "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
- # When 'percent' is used, the value is rounded if necessary.
- # The instance is considered available if all of the following conditions
- # are satisfied:
- # 1. Instance's status is RUNNING.
- # 2. Instance's currentAction is NONE (in particular its liveness health
- # check result was observed to be HEALTHY at least once as it passed
- # VERIFYING).
- # 3. There is no outgoing action on an instance triggered by IGM.
- #
- # By default, number of concurrently autohealed instances is smaller than
- # the managed instance group target size. However, if a zonal managed
- # instance group has only one instance, or a regional managed instance
- # group has only one instance per zone, autohealing will recreate these
- # instances when they become unhealthy.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- },
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Sets the instance template to use when creating new instances or recreating
-instances in this group. Existing instances are not affected.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be
- # created.
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Modifies the target pools to which all new instances in this group are
-assigned. Existing instances in the group are not affected.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, Name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the
- # contents. This field is used for optimistic locking when you update the
- # target pool entries. This field is optional.
- "targetPools": [ # The URL of all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
- # apply to all of the instances in the managed instance group.
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="startInstances">startInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-started. This method increases thetargetSize and decreases the targetStoppedSize
-of the managed instance group by the number of instances that you start.
-The startInstances operation is marked DONE if
-the startInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances
-method.
-
-In this request, you can only specify instances that are stopped. For
-example, if an instance was previously stopped using the stopInstances
-method, it can be started using the startInstances method.
-
-If a health check is attached to the managed instance group, the specified
-instances will be verified as healthy after they are started.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, Name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "instances": [ # The URLs of one or more instances to start. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="stopInstances">stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-immediately stopped. You can only specify instances that are running in
-this request. This method reduces thetargetSize and increases the targetStoppedSize
-of the managed instance group by the number of instances that you stop.
-The stopInstances operation is marked DONE if
-the stopInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances
-method.
-
-If the standbyPolicy.initialDelaySec field is set, the group
-delays stopping the instances until initialDelaySec have
-passed from instance.creationTimestamp (that is, when the
-instance was created). This delay gives your application time to
-set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
-will be zero delay.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is stopped.
-
-Stopped instances can be started using the startInstances
-method.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, The name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "forceStop": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
- # stop the instances, skipping initialization on them.
- "instances": [ # The URLs of one or more instances to stop. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="suspendInstances">suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Flags the specified instances in the managed instance group to be
-immediately suspended. You can only specify instances that are running in
-this request. This method reduces thetargetSize and increases the targetSuspendedSize
-of the managed instance group by the number of instances that you suspend.
-The suspendInstances operation is marked DONE if
-the suspendInstances request is successful. The underlying
-actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances
-method.
-
-If the standbyPolicy.initialDelaySec field is set, the group
-delays suspension of the instances until initialDelaySec have
-passed from instance.creationTimestamp (that is, when the
-instance was created). This delay gives your application time to
-set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
-will be zero delay.
-
-If the group is part of a backend
-service that has enabled
-connection draining, it can take up to 60 seconds after the connection
-draining duration has elapsed before the VM instance is suspended.
-
-Suspended instances can be resumed using the resumeInstances
-method.
-
-You can specify a maximum of 1000 instances with this method per request.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, Name of the managed instance group. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "forceSuspend": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
- # suspend the instances, skipping initialization on them.
- "instances": [ # The URLs of one or more instances to suspend. This can be a full URL or
- # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
- "A String",
- ],
-}
-
- requestId: string, An optional request ID to identify requests. Specify a unique request ID so
-that if you must retry your request, the server will know to ignore the
-request if it has already been completed.
-
-For example, consider a situation where you make an initial request and
-the request times out. If you make the request again with the same
-request ID, the server can check if original operation with the same
-request ID was received, and if so, will ignore the second request. This
-prevents clients from accidentally creating duplicate commitments.
-
-The request ID must be
-a valid UUID with the exception that zero UUID is not supported
-(00000000-0000-0000-0000-000000000000).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents an Operation resource.
- #
- # Google Compute Engine has three Operation resources:
- #
- # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
- # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
- # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
- #
- # You can use an operation resource to manage asynchronous API requests.
- # For more information, readHandling
- # API responses.
- #
- # Operations can be global, regional or zonal.
- #
- # - For global operations, use the `globalOperations`
- # resource.
- # - For regional operations, use the
- # `regionOperations` resource.
- # - For zonal operations, use
- # the `zoneOperations` resource.
- #
- #
- #
- # For more information, read
- # Global, Regional, and Zonal Resources.
- #
- # Note that completed Operation resources have a limited
- # retention period.
- "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
- # Not present otherwise.
- "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "description": "A String", # [Output Only] A textual description of the operation, which is
- # set when the operation is created.
- "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
- # text format.
- "error": { # [Output Only] If errors are generated during processing of the operation,
- # this field will be populated.
- "errors": [ # [Output Only] The array of errors encountered while processing this
- # operation.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "errorDetails": [ # [Output Only] An optional list of messages that contain the error
- # details. There is a set of defined message types to use for providing
- # details.The syntax depends on the error code. For example,
- # QuotaExceededInfo will have details when the error code is
- # QUOTA_EXCEEDED.
- {
- "errorInfo": { # Describes the cause of the error with structured details.
- #
- # Example of an error when contacting the "pubsub.googleapis.com" API when it
- # is not enabled:
- #
- # { "reason": "API_DISABLED"
- # "domain": "googleapis.com"
- # "metadata": {
- # "resource": "projects/123",
- # "service": "pubsub.googleapis.com"
- # }
- # }
- #
- # This response indicates that the pubsub.googleapis.com API is not enabled.
- #
- # Example of an error that is returned when attempting to create a Spanner
- # instance in a region that is out of stock:
- #
- # { "reason": "STOCKOUT"
- # "domain": "spanner.googleapis.com",
- # "metadata": {
- # "availableRegions": "us-central1,us-east2"
- # }
- # }
- "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
- # is typically the registered service name of the tool or product that
- # generates the error. Example: "pubsub.googleapis.com". If the error is
- # generated by some common infrastructure, the error domain must be a
- # globally unique value that identifies the infrastructure. For Google API
- # infrastructure, the error domain is "googleapis.com".
- "metadatas": { # Additional structured details about this error.
- #
- # Keys must match a regular expression of `a-z+` but should
- # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
- # length. When identifying the current value of an exceeded limit, the units
- # should be contained in the key, not the value. For example, rather than
- # `{"instanceLimit": "100/request"}`, should be returned as,
- # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
- # instances that can be created in a single (batch) request.
- "a_key": "A String",
- },
- "reason": "A String", # The reason of the error. This is a constant value that identifies the
- # proximate cause of the error. Error reasons are unique within a particular
- # domain of errors. This should be at most 63 characters and match a
- # regular expression of `A-Z+[A-Z0-9]`, which represents
- # UPPER_SNAKE_CASE.
- },
- "help": { # Provides links to documentation or for performing an out of band action.
- #
- # For example, if a quota check failed with an error indicating the calling
- # project hasn't enabled the accessed service, this can contain a URL pointing
- # directly to the right place in the developer console to flip the bit.
- "links": [ # URL(s) pointing to additional information on handling the current error.
- { # Describes a URL link.
- "description": "A String", # Describes what the link offers.
- "url": "A String", # The URL of the link.
- },
- ],
- },
- "localizedMessage": { # Provides a localized error message that is safe to return to the user
- # which can be attached to an RPC error.
- "locale": "A String", # The locale used following the specification defined at
- # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- # Examples are: "en-US", "fr-CH", "es-MX"
- "message": "A String", # The localized error message in the above locale.
- },
- "quotaInfo": { # Additional details for quota exceeded error for resource quota.
- "dimensions": { # The map holding related quota dimensions.
- "a_key": "A String",
- },
- "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
- # type or metric.
- "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
- # or metric.
- "limitName": "A String", # The name of the quota limit.
- "metricName": "A String", # The Compute Engine quota metric name.
- "rolloutStatus": "A String", # Rollout status of the future quota limit.
- },
- },
- ],
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
- # This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
- },
- ],
- },
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
- # message that was returned, such as `NOT FOUND`.
- "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
- # status code that was returned. For example, a `404` means the
- # resource was not found.
- "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
- # defined by the server.
- "insertTime": "A String", # [Output Only] The time that this operation was requested.
- # This value is inRFC3339
- # text format.
- "instancesBulkInsertOperationMetadata": {
- "perLocationStatus": { # Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
- "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
- "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
- # error.
- "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
- # if the flow is rolling forward or rolling back.
- "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
- },
- },
- },
- "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
- # Operation resources.
- "name": "A String", # [Output Only] Name of the operation.
- "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
- # group of operations results from a `bulkInsert` API request.
- "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
- # `update`, or `delete`, and so on.
- "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
- # There is no requirement that this be linear or support any granularity of
- # operations. This should not be used to guess when the operation will be
- # complete. This number should monotonically increase as the operation
- # progresses.
- "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
- # applicable when performing regional operations.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
- "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
- # this field will contain information on all underlying zonal actions and
- # their state.
- "clientOperationId": "A String", # [Output Only] The client operation id.
- "perLocationOperations": { # [Output Only] Status information per location (location name is key).
- # Example key: zones/us-central1-a
- "a_key": {
- "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
- # populated.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- },
- "state": "A String", # [Output Only] Status of the action, which can be one of the following:
- # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
- },
- },
- },
- "startTime": "A String", # [Output Only] The time that this operation was started by the server.
- # This value is inRFC3339
- # text format.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the
- # following:
- # `PENDING`, `RUNNING`, or `DONE`.
- "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
- # operation.
- "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
- # of the target resource.
- "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
- # operations related to creating a snapshot, this points to the disk
- # that the snapshot was created from.
- "user": "A String", # [Output Only] User who requested the operation, for example:
- # `[email protected]` or
- # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
- "warnings": [ # [Output Only] If warning messages are generated during processing of the
- # operation, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
- # Engine returns NO_RESULTS_ON_PAGE if there
- # are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key:
- # value format. For example:
- #
- # "data": [
- # {
- # "key": "scope",
- # "value": "zones/us-east1-d"
- # }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being
- # returned. For example, for warnings where there are no results in a list
- # request for a particular zone, this key might be scope and
- # the key value might be the zone name. Other examples might be a key
- # indicating a deprecated resource and a suggested replacement, or a
- # warning about invalid network settings (for example, if an instance
- # attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
- "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
- # applicable when performing per-zone operations.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
- <pre>Returns permissions that a caller has on the specified resource.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, The name of the region for this request. (required)
- resource: string, Name or id of the resource for this request. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed.
- "A String",
- ],
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
- # allowed.
- "A String",
- ],
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
- <pre>Updates a managed instance group using the information that you specify
-in the request.
-This operation is marked as DONE when the group is updated
-even if the instances in the group have not yet been updated. You must
-separately verify the status of the individual instances with thelistmanagedinstances
-method.
-
-If you update your group to specify a new template or instance
-configuration, it's possible that your intended specification for each VM
-in the group is different from the current state of that VM. To learn how
-to apply an updated configuration to the VMs in a MIG, seeUpdating instances in
-a MIG.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region scoping this request. (required)
- instanceGroupManager: string, The name of the instance group manager. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Represents a Managed Instance Group resource.
- #
- # An instance group is a collection of VM instances that you can manage as a
- # single entity. For more information, readInstance groups.
- #
- # For zonal Managed Instance Group, use the instanceGroupManagers
- # resource.
- #
- # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
- "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration
- # for the group.
- "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
- #
- # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's
- # instances to apply the configuration. To apply the configuration, set the
- # group's updatePolicy.type field to use proactive updates or
- # use the applyUpdatesToInstances method.
- "labels": { # The label key-value pairs that you want to patch onto the instance.
- "a_key": "A String",
- },
- "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For
- # more information, see Project and
- # instance metadata.
- "a_key": "A String",
- },
- },
- },
- "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify
- # only one value.
- {
- "autoHealingTriggers": { # Restricts what triggers autohealing.
- "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
- # this field controls whether to trigger VM autohealing based on a failed
- # health check. Valid values are:
- #
- # - ON (default): The group recreates running VMs that
- # fail the application-based health check.
- # - OFF: When set to OFF, you can still observe instance
- # health state, but the group does not recreate VMs that fail the
- # application-based health check. This is useful for troubleshooting and
- # setting up your health check configuration.
- },
- "healthCheck": "A String", # The URL for the health check that signals autohealing.
- "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
- # initialize and run its startup script. During a VM's initial delay
- # period, the MIG ignores unsuccessful health checks because the VM might
- # be in the startup process. This prevents the MIG from prematurely
- # recreating a VM. If the health check receives a healthy response during
- # the initial delay, it indicates that the startup process is complete and
- # the VM is ready. The value of initial delay must be between 0 and 3600
- # seconds. The default value is 0.
- "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
- # When 'percent' is used, the value is rounded if necessary.
- # The instance is considered available if all of the following conditions
- # are satisfied:
- # 1. Instance's status is RUNNING.
- # 2. Instance's currentAction is NONE (in particular its liveness health
- # check result was observed to be HEALTHY at least once as it passed
- # VERIFYING).
- # 3. There is no outgoing action on an instance triggered by IGM.
- #
- # By default, number of concurrently autohealed instances is smaller than
- # the managed instance group target size. However, if a zonal managed
- # instance group has only one instance, or a regional managed instance
- # group has only one instance per zone, autohealing will recreate these
- # instances when they become unhealthy.
- "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
- # specific mode.
- #
- #
- #
- # - If the value is fixed, then the calculated
- # value is equal to the fixed value.
- # - If the value is a percent, then the
- # calculated
- # value is percent/100 * targetSize. For example,
- # the calculated value of a 80% of a managed instance group
- # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
- # is a remainder, the number is rounded.
- "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
- "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
- # example, specify 80 for 80%.
- },
- },
- ],
- "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of
- # all VMs in a MIG. The maximum character length is 58 and the name must
- # comply with RFC1035 format.
- #
- # When a VM is created in the group, the MIG appends a hyphen and a random
- # four-character string to the base instance name. If you want the MIG to
- # assign sequential numbers instead of a random string, then end the base
- # instance name with a hyphen followed by one or more hash symbols. The hash
- # symbols indicate the number of digits. For example, a base instance name of
- # "vm-###" results in "vm-001" as a VM name.
- # @pattern
- # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
- "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339
- # text format.
- "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances
- # in this managed instance group that are scheduled for each of those
- # actions.
- "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group
- # that are scheduled to be abandoned. Abandoning an instance removes it
- # from the managed instance group without deleting it.
- "adopting": 42, # [Output Only] The number of instances in the managed instance group that
- # are scheduled to be adopted or are currently being adopted.
- "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be created or are currently being created. If the group
- # fails to create any of these instances, it tries again until it creates
- # the instance successfully.
- #
- # If you have disabled creation retries, this field will not be populated;
- # instead, the creatingWithoutRetries field will be populated.
- "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group
- # will attempt to create atomically, in a batch mode. If the desired count
- # of instances can not be created, entire batch will be deleted and the
- # group will decrease its targetSize value accordingly.
- "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group
- # will attempt to create. The group attempts to create each instance
- # only once. If the group fails to create any of these instances, it
- # decreases the group's targetSize value accordingly.
- "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be deleted or are currently being deleted.
- "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are running and have no scheduled actions.
- "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group
- # is currently queuing.
- "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are scheduled to be recreated or are currently being being recreated.
- # Recreating an instance deletes the existing root persistent disk
- # and creates a new disk from the image that is defined in the
- # instance template.
- "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that
- # are being reconfigured with properties that do not require a restart
- # or a recreate action. For example, setting or removing target
- # pools for the instance.
- "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be restarted or are currently being restarted.
"resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
# are scheduled to be resumed or are currently being resumed.
@@ -17535,6 +12000,7 @@
# - Manually change the targetSuspendedSize using the update
# method.
"updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
"instanceRedistributionType": "A String", # The
# instance redistribution policy for regional managed instance groups.
# Valid values are:
@@ -17848,6 +12314,5808 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Inserts or patches per-instance configurations for the managed instance
+group. perInstanceConfig.name serves as a key used to
+distinguish whether to perform insert or patch.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request, should conform to RFC1035. (required)
+ instanceGroupManager: string, The name of the managed instance group.
+It should conform to RFC1035. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # RegionInstanceGroupManagers.patchPerInstanceConfigs
+ "perInstanceConfigs": [ # The list of per-instance configurations to insert or patch on this managed
+ # instance group.
+ {
+ "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in
+ # optimistic locking. It is ignored when inserting a per-instance
+ # config. An up-to-date fingerprint must be provided in order to update an
+ # existing per-instance configuration or the field needs to be unset.
+ "name": "A String", # The name of a per-instance configuration and its corresponding instance.
+ # Serves as a merge key during UpdatePerInstanceConfigs
+ # operations, that is, if a per-instance configuration with the same name
+ # exists then it will be updated, otherwise a new one will be created for the
+ # VM instance with the same name. An attempt to create a per-instance
+ # configuration for a VM instance that either doesn't exist or is not part
+ # of the group will result in an error.
+ "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
+ # preserved state generated from a stateful policy.
+ "disks": { # Preserved disks defined for this instance.
+ # This map is keyed with the device names of the disks.
+ "a_key": {
+ "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
+ # update, instance recreate operations. This flag is used to configure
+ # if the disk should be deleted after it is no longer used by the group,
+ # e.g. when the given instance or the whole MIG is deleted.
+ # Note: disks attached in READ_ONLY mode cannot be
+ # auto-deleted.
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
+ # disk in READ_WRITE mode.
+ "source": "A String", # The URL of the disk resource that is stateful and should be attached
+ # to the VM instance.
+ },
+ },
+ "externalIPs": { # Preserved external IPs defined for this instance.
+ # This map is keyed with the name of the network interface.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ "ipAddress": { # Ip address representation
+ "address": "A String", # The URL of the reservation for this IP address.
+ "literal": "A String", # An IPv4 internal network address to assign to the instance for this
+ # network interface.
+ },
+ },
+ },
+ "internalIPs": { # Preserved internal IPs defined for this instance.
+ # This map is keyed with the name of the network interface.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ "ipAddress": { # Ip address representation
+ "address": "A String", # The URL of the reservation for this IP address.
+ "literal": "A String", # An IPv4 internal network address to assign to the instance for this
+ # network interface.
+ },
+ },
+ },
+ "metadata": { # Preserved metadata defined for this instance.
+ "a_key": "A String",
+ },
+ },
+ "status": "A String", # The status of applying this per-instance configuration on the corresponding
+ # managed instance.
+ },
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified VM instances in the managed instance group to be
+immediately recreated. Each instance is recreated using the group's current
+configuration. This operation is marked as DONE when the flag
+is set even if the instances have not yet been recreated. You must
+separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking
+the status of managed instances.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is removed or deleted.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instances": [ # The URLs of one or more instances to recreate. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</code>
+ <pre>Changes the intended size of the managed instance group. If you increase
+the size, the group creates new instances using the current instance
+template. If you decrease the size, the group deletes one or more
+instances.
+
+The resize operation is marked DONE if theresize request is successful. The underlying actions take
+additional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances
+method.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is removed or deleted.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ size: integer, Number of instances that should exist in this instance group
+manager. (required)
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resizeAdvanced">resizeAdvanced(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Resizes the regional managed instance group with advanced configuration
+options like disabling creation retries. This is an extended version of theresize method.
+
+If you increase the size, the group creates new instances using the current
+instance template. If you decrease the size, the group deletes one or more
+instances.
+
+The resize operation is marked DONE if theresize request is successful. The underlying actions take
+additional time. You must separately verify the status of thecreating or deleting actions with the get
+orlistmanagedinstances
+method.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is removed or deleted.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request.
+It must be a string that meets the requirements in RFC1035. (required)
+ instanceGroupManager: string, The name of the managed instance group.
+It must be a string that meets the requirements in RFC1035. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all
+ # instances initiated by this resize request only once. If there is an error
+ # during creation, the managed instance group does not retry create this
+ # instance, and we will decrease the targetSize of the request
+ # instead. If the flag is false, the group attempts to recreate each instance
+ # continuously until it succeeds.
+ #
+ # This flag matters only in the first attempt of creation of an instance.
+ # After an instance is successfully created while this flag is enabled, the
+ # instance behaves the same way as all the other instances created with a
+ # regular resize request. In particular, if a running instance dies
+ # unexpectedly at a later time and needs to be recreated, this mode does not
+ # affect the recreation behavior in that scenario.
+ #
+ # This flag is applicable only to the current resize request. It does not
+ # influence other resize requests in any way.
+ #
+ # You can see which instances ar being created in which mode by calling
+ # the get or listManagedInstances API.
+ "targetSize": 42, # The number of running instances that the managed instance group should
+ # maintain at any given time. The group automatically adds or removes
+ # instances to maintain the number of instances specified by this parameter.
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resumeInstances">resumeInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+resumed. This method increases thetargetSize and decreases the targetSuspendedSize
+of the managed instance group by the number of instances that you resume.
+The resumeInstances operation is marked DONE if
+the resumeInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances
+method.
+
+In this request, you can only specify instances that are suspended. For
+example, if an instance was previously suspended using the suspendInstances
+method, it can be resumed using the resumeInstances method.
+
+If a health check is attached to the managed instance group, the specified
+instances will be verified as healthy after they are resumed.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instances": [ # The URLs of one or more instances to resume. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Modifies the autohealing policy for the instances in this managed
+instance group.
+[Deprecated] This method is deprecated. UseregionInstanceGroupManagers.patch instead.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "autoHealingPolicies": [
+ {
+ "autoHealingTriggers": { # Restricts what triggers autohealing.
+ "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
+ # this field controls whether to trigger VM autohealing based on a failed
+ # health check. Valid values are:
+ #
+ # - ON (default): The group recreates running VMs that
+ # fail the application-based health check.
+ # - OFF: When set to OFF, you can still observe instance
+ # health state, but the group does not recreate VMs that fail the
+ # application-based health check. This is useful for troubleshooting and
+ # setting up your health check configuration.
+ },
+ "healthCheck": "A String", # The URL for the health check that signals autohealing.
+ "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
+ # initialize and run its startup script. During a VM's initial delay
+ # period, the MIG ignores unsuccessful health checks because the VM might
+ # be in the startup process. This prevents the MIG from prematurely
+ # recreating a VM. If the health check receives a healthy response during
+ # the initial delay, it indicates that the startup process is complete and
+ # the VM is ready. The value of initial delay must be between 0 and 3600
+ # seconds. The default value is 0.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
+ # When 'percent' is used, the value is rounded if necessary.
+ # The instance is considered available if all of the following conditions
+ # are satisfied:
+ # 1. Instance's status is RUNNING.
+ # 2. Instance's currentAction is NONE (in particular its liveness health
+ # check result was observed to be HEALTHY at least once as it passed
+ # VERIFYING).
+ # 3. There is no outgoing action on an instance triggered by IGM.
+ #
+ # By default, number of concurrently autohealed instances is smaller than
+ # the managed instance group target size. However, if a zonal managed
+ # instance group has only one instance, or a regional managed instance
+ # group has only one instance per zone, autohealing will recreate these
+ # instances when they become unhealthy.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ },
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Sets the instance template to use when creating new instances or recreating
+instances in this group. Existing instances are not affected.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be
+ # created.
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Modifies the target pools to which all new instances in this group are
+assigned. Existing instances in the group are not affected.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the
+ # contents. This field is used for optimistic locking when you update the
+ # target pool entries. This field is optional.
+ "targetPools": [ # The URL of all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
+ # apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="startInstances">startInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+started. This method increases thetargetSize and decreases the targetStoppedSize
+of the managed instance group by the number of instances that you start.
+The startInstances operation is marked DONE if
+the startInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances
+method.
+
+In this request, you can only specify instances that are stopped. For
+example, if an instance was previously stopped using the stopInstances
+method, it can be started using the startInstances method.
+
+If a health check is attached to the managed instance group, the specified
+instances will be verified as healthy after they are started.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "instances": [ # The URLs of one or more instances to start. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="stopInstances">stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+immediately stopped. You can only specify instances that are running in
+this request. This method reduces thetargetSize and increases the targetStoppedSize
+of the managed instance group by the number of instances that you stop.
+The stopInstances operation is marked DONE if
+the stopInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances
+method.
+
+If the standbyPolicy.initialDelaySec field is set, the group
+delays stopping the instances until initialDelaySec have
+passed from instance.creationTimestamp (that is, when the
+instance was created). This delay gives your application time to
+set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
+will be zero delay.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is stopped.
+
+Stopped instances can be started using the startInstances
+method.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "forceStop": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
+ # stop the instances, skipping initialization on them.
+ "instances": [ # The URLs of one or more instances to stop. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="suspendInstances">suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Flags the specified instances in the managed instance group to be
+immediately suspended. You can only specify instances that are running in
+this request. This method reduces thetargetSize and increases the targetSuspendedSize
+of the managed instance group by the number of instances that you suspend.
+The suspendInstances operation is marked DONE if
+the suspendInstances request is successful. The underlying
+actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances
+method.
+
+If the standbyPolicy.initialDelaySec field is set, the group
+delays suspension of the instances until initialDelaySec have
+passed from instance.creationTimestamp (that is, when the
+instance was created). This delay gives your application time to
+set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
+will be zero delay.
+
+If the group is part of a backend
+service that has enabled
+connection draining, it can take up to 60 seconds after the connection
+draining duration has elapsed before the VM instance is suspended.
+
+Suspended instances can be resumed using the resumeInstances
+method.
+
+You can specify a maximum of 1000 instances with this method per request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, Name of the managed instance group. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "forceSuspend": True or False, # If this flag is set to true, the Instance Group Manager will proceed to
+ # suspend the instances, skipping initialization on them.
+ "instances": [ # The URLs of one or more instances to suspend. This can be a full URL or
+ # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ # allowed.
+ "A String",
+ ],
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Updates a managed instance group using the information that you specify
+in the request.
+This operation is marked as DONE when the group is updated
+even if the instances in the group have not yet been updated. You must
+separately verify the status of the individual instances with thelistmanagedinstances
+method.
+
+If you update your group to specify a new template or instance
+configuration, it's possible that your intended specification for each VM
+in the group is different from the current state of that VM. To learn how
+to apply an updated configuration to the VMs in a MIG, seeUpdating instances in
+a MIG.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ instanceGroupManager: string, The name of the instance group manager. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Managed Instance Group resource.
+ #
+ # An instance group is a collection of VM instances that you can manage as a
+ # single entity. For more information, readInstance groups.
+ #
+ # For zonal Managed Instance Group, use the instanceGroupManagers
+ # resource.
+ #
+ # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
+ "allInstancesConfig": { # Specifies configuration that overrides the instance template configuration
+ # for the group.
+ "properties": { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
+ #
+ # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's
+ # instances to apply the configuration. To apply the configuration, set the
+ # group's updatePolicy.type field to use proactive updates or
+ # use the applyUpdatesToInstances method.
+ "labels": { # The label key-value pairs that you want to patch onto the instance.
+ "a_key": "A String",
+ },
+ "metadata": { # The metadata key-value pairs that you want to patch onto the instance. For
+ # more information, see Project and
+ # instance metadata.
+ "a_key": "A String",
+ },
+ },
+ },
+ "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify
+ # only one value.
+ {
+ "autoHealingTriggers": { # Restricts what triggers autohealing.
+ "onHealthCheck": "A String", # If you have configured an application-based health check for the group,
+ # this field controls whether to trigger VM autohealing based on a failed
+ # health check. Valid values are:
+ #
+ # - ON (default): The group recreates running VMs that
+ # fail the application-based health check.
+ # - OFF: When set to OFF, you can still observe instance
+ # health state, but the group does not recreate VMs that fail the
+ # application-based health check. This is useful for troubleshooting and
+ # setting up your health check configuration.
+ },
+ "healthCheck": "A String", # The URL for the health check that signals autohealing.
+ "initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to
+ # initialize and run its startup script. During a VM's initial delay
+ # period, the MIG ignores unsuccessful health checks because the VM might
+ # be in the startup process. This prevents the MIG from prematurely
+ # recreating a VM. If the health check receives a healthy response during
+ # the initial delay, it indicates that the startup process is complete and
+ # the VM is ready. The value of initial delay must be between 0 and 3600
+ # seconds. The default value is 0.
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when autohealing.
+ # When 'percent' is used, the value is rounded if necessary.
+ # The instance is considered available if all of the following conditions
+ # are satisfied:
+ # 1. Instance's status is RUNNING.
+ # 2. Instance's currentAction is NONE (in particular its liveness health
+ # check result was observed to be HEALTHY at least once as it passed
+ # VERIFYING).
+ # 3. There is no outgoing action on an instance triggered by IGM.
+ #
+ # By default, number of concurrently autohealed instances is smaller than
+ # the managed instance group target size. However, if a zonal managed
+ # instance group has only one instance, or a regional managed instance
+ # group has only one instance per zone, autohealing will recreate these
+ # instances when they become unhealthy.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ },
+ ],
+ "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of
+ # all VMs in a MIG. The maximum character length is 58 and the name must
+ # comply with RFC1035 format.
+ #
+ # When a VM is created in the group, the MIG appends a hyphen and a random
+ # four-character string to the base instance name. If you want the MIG to
+ # assign sequential numbers instead of a random string, then end the base
+ # instance name with a hyphen followed by one or more hash symbols. The hash
+ # symbols indicate the number of digits. For example, a base instance name of
+ # "vm-###" results in "vm-001" as a VM name.
+ # @pattern
+ # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
+ "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp for this managed instance group inRFC3339
+ # text format.
+ "currentActions": { # Output only. [Output Only] The list of instance actions and the number of instances
+ # in this managed instance group that are scheduled for each of those
+ # actions.
+ "abandoning": 42, # Output only. [Output Only] The total number of instances in the managed instance group
+ # that are scheduled to be abandoned. Abandoning an instance removes it
+ # from the managed instance group without deleting it.
+ "adopting": 42, # [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be adopted or are currently being adopted.
+ "creating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be created or are currently being created. If the group
+ # fails to create any of these instances, it tries again until it creates
+ # the instance successfully.
+ #
+ # If you have disabled creation retries, this field will not be populated;
+ # instead, the creatingWithoutRetries field will be populated.
+ "creatingAtomically": 42, # Output only. [Output Only] The number of instances that the managed instance group
+ # will attempt to create atomically, in a batch mode. If the desired count
+ # of instances can not be created, entire batch will be deleted and the
+ # group will decrease its targetSize value accordingly.
+ "creatingWithoutRetries": 42, # Output only. [Output Only] The number of instances that the managed instance group
+ # will attempt to create. The group attempts to create each instance
+ # only once. If the group fails to create any of these instances, it
+ # decreases the group's targetSize value accordingly.
+ "deleting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be deleted or are currently being deleted.
+ "none": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are running and have no scheduled actions.
+ "queuing": 42, # Output only. [Output Only] The number of instances that the managed instance group
+ # is currently queuing.
+ "recreating": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be recreated or are currently being being recreated.
+ # Recreating an instance deletes the existing root persistent disk
+ # and creates a new disk from the image that is defined in the
+ # instance template.
+ "refreshing": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are being reconfigured with properties that do not require a restart
+ # or a recreate action. For example, setting or removing target
+ # pools for the instance.
+ "restarting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
+ "restartingInPlace": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be restarted or are currently being restarted.
+ "resuming": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be resumed or are currently being resumed.
+ "starting": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be started or are currently being started.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be stopped or are currently being stopped.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are scheduled to be suspended or are currently being suspended.
+ "verifying": 42, # Output only. [Output Only] The number of instances in the managed instance group that
+ # are being verified. See the managedInstances[].currentAction
+ # property in the listManagedInstances method documentation.
+ },
+ "description": "A String", # An optional description of this resource.
+ "distributionPolicy": { # Policy specifying the intended distribution of managed instances across
+ # zones in a regional managed instance group.
+ "targetShape": "A String", # The distribution shape to which the group converges either proactively or
+ # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
+ "zones": [ # Zones where the regional managed instance group will create and manage
+ # its instances.
+ {
+ "zone": "A String", # The URL of thezone.
+ # The zone must exist in the region where the managed instance group is
+ # located.
+ },
+ ],
+ },
+ "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported,NO_FAILOVER. The default is NO_FAILOVER.
+ "fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking.
+ # It will be ignored when inserting an InstanceGroupManager. An up-to-date
+ # fingerprint must be provided in order to update the InstanceGroupManager,
+ # otherwise the request will fail with error412 conditionNotMet.
+ #
+ # To see the latest fingerprint, make a get() request to
+ # retrieve an InstanceGroupManager.
+ "id": "A String", # Output only. [Output Only] A unique identifier for this resource type. The server
+ # generates this identifier.
+ "instanceFlexibilityPolicy": { # Instance flexibility allowing MIG to create VMs from multiple
+ # types of machines.
+ # Instance flexibility configuration on MIG overrides instance
+ # template configuration.
+ "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
+ # when creating new VMs.
+ "a_key": {
+ "disks": [ # List of disks to be attached to the instances created from this
+ # selection.
+ { # An instance-attached disk resource.
+ "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
+ # or X86_64.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+ # deleted (but not when the disk is detached from the instance).
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+ # partition of the disk for its root filesystem.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+ # running within the instance. This name can be used to reference the device
+ # for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this
+ # disk, in the form persistent-disk-x, where x is a number
+ # assigned by Google Compute Engine. This field is only applicable for
+ # persistent disks.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+ # encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using
+ # an encryption key that you provide. If you are attaching an existing
+ # disk that is already encrypted, this field decrypts the disk using
+ # the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the
+ # same key again when you attempt to use this resource at a later time. For
+ # example, you must provide the key when you create a snapshot or an image
+ # from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted
+ # using an automatically generated key and you do not need to provide a key
+ # to use the disk later.
+ #
+ # Note:
+ #
+ # Instance templates do not storecustomer-supplied
+ # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+ #
+ # You cannot create VMs that have disks with customer-supplied keys using
+ # the bulk
+ # insert method.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "diskSizeGb": "A String", # The size of the disk in GB.
+ "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+ # currently attached to another instance. If you try to force attach a zonal
+ # disk to an instance, you will receive an error.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
+ # boot disk. If you have many disks attached to an instance, each
+ # disk would have a unique index number.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This field is persisted and returned for instanceTemplate and not returned
+ # in the context of instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ "architecture": "A String", # The architecture of the attached disk. Valid values are
+ # arm64 or x86_64.
+ "description": "A String", # An optional description. Provide this property when creating the disk.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+ # of the instance. If a disk with the same name already exists in the given
+ # region, the existing disk is attached to the new instance and the
+ # new disk is not created.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+ # 10 GB. If you specify a sourceImage, which is required for
+ # boot disks, the default size is the size of the sourceImage.
+ # If you do not specify a sourceImage, the default disk size
+ # is 500 GB.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+ # the default is pd-standard, specified using the full URL.
+ # For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ #
+ # For a full list of acceptable values, seePersistent disk
+ # types. If you specify this field when creating a VM, you can provide
+ # either the full or partial URL. For example, the following values are
+ # valid:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
+ #
+ #
+ # If you specify this field when creating or updating an instance template
+ # or all-instances configuration, specify the type of the disk, not the
+ # URL. For example: pd-standard.
+ "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ #
+ # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+ # which is either SCSI or NVME. The default isSCSI.
+ "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+ # persistent disks.
+ "a_key": "A String",
+ },
+ "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+ # disk.
+ "A String",
+ ],
+ "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+ "A String",
+ ],
+ "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+ # more than one instance.
+ "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+ # is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+ # of I/O operations per second that the disk can handle. Values must be
+ # between 10,000 and 120,000. For more details, see theExtreme persistent
+ # disk documentation.
+ "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+ # number of throughput mb per second that the disk can handle. Values must
+ # greater than or equal to 1.
+ "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+ # the URLs of the zones where the disk should be replicated to.
+ # You must provide exactly two replica zones, and one zone must be the same
+ # as the instance zone.
+ "A String",
+ ],
+ "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ # have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+ # format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
+ # empty.
+ "a_key": "A String",
+ },
+ "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+ # Specified using the full or partial URL. For instance template, specify
+ # only the resource policy name.
+ "A String",
+ ],
+ "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+ # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # To create a disk with one of the public operating system
+ # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-9
+ #
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+ #
+ #
+ # To create a disk with a custom image that you created, specify the
+ # image name in the following format:
+ #
+ # global/images/my-custom-image
+ #
+ #
+ # You can also specify a custom image by its image family, which returns
+ # the latest version of the image in that family. Replace the image name
+ # with family/family-name:
+ #
+ # global/images/family/my-image-family
+ #
+ #
+ # If the source image is deleted later, this field will not be set.
+ "sourceImageEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source image. Required if the source image is
+ # protected by a customer-supplied encryption key.
+ #
+ # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+ # encryption keys, so you cannot create disks for instances in a managed instance group if the
+ # source images are encrypted with your own keys.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+ # instance boot disk, one of initializeParams.sourceSnapshot
+ # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # us-central1-a/instantSnapshots/my-backup
+ #
+ #
+ # If the source instant-snapshot is deleted later, this field will not be
+ # set.
+ "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+ # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # global/snapshots/my-backup
+ #
+ #
+ # If the source snapshot is deleted later, this field will not be set.
+ #
+ # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+ # an image instead when you create VMs using
+ # the bulk
+ # insert method.
+ "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source snapshot.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+ # this as a partial or full URL to the resource. For example, the following
+ # are valid values:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+ # - projects/project/zones/zone/storagePools/storagePool
+ # - zones/zone/storagePools/storagePool
+ },
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+ # either SCSI or NVME. For most machine types, the
+ # default is SCSI. Local SSDs can use either NVME or SCSI.
+ # In certain configurations, persistent disks can use NVMe. For more
+ # information, seeAbout
+ # persistent disks.
+ "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+ "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
+ # disk is not allowed to be detached from the instance, or to be used as the
+ # source of the snapshot creation, and the image creation. The instance with
+ # at least one locked attached disk is not allow to be used as source of
+ # machine image creation, instant snapshot creation, and not allowed to be
+ # deleted with --keep-disk parameter set to true for locked disks.
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+ # in READ_WRITE mode.
+ "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+ # field is set to PRESERVED if the LocalSSD data has been saved
+ # to a persistent location by customer request. (see the
+ # discard_local_ssd option on Stop/Suspend).
+ # Read-only in the api.
+ "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
+ # these are public keys which are safe to store in public
+ "dbs": [ # The Key Database (db).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "dbxs": [ # The forbidden key database (dbx).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "keks": [ # The Key Exchange Key (KEK).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "pk": { # The Platform Key (PK).
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ },
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+ # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # If desired, you can also attach existing non-root persistent disks using
+ # this property. This field is only applicable for persistent disks.
+ #
+ # Note that for InstanceTemplate, specify the disk name for zonal disk,
+ # and the URL for regional disk.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+ "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
+ # URLs to the license resource. Unlike regular licenses, user provided
+ # licenses can be modified after the disk is created.
+ "A String",
+ ],
+ },
+ ],
+ "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
+ "A String",
+ ],
+ "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+ # e.g. 'Intel Ice Lake'.
+ "rank": 42, # Preference of this instance selection. Lower number means higher
+ # preference. MIG will first try to create a VM based on the machine-type
+ # with lowest rank and fallback to next rank based on availability.
+ # Machine types and instance selections with the same rank have the same
+ # preference.
+ },
+ },
+ "instanceSelections": { # Named instance selections configuring properties that the group will use
+ # when creating new VMs.
+ "a_key": {
+ "disks": [ # List of disks to be attached to the instances created from this
+ # selection.
+ { # An instance-attached disk resource.
+ "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
+ # or X86_64.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+ # deleted (but not when the disk is detached from the instance).
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+ # partition of the disk for its root filesystem.
+ "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+ # running within the instance. This name can be used to reference the device
+ # for mounting, resizing, and so on, from within the instance.
+ #
+ # If not specified, the server chooses a default device name to apply to this
+ # disk, in the form persistent-disk-x, where x is a number
+ # assigned by Google Compute Engine. This field is only applicable for
+ # persistent disks.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+ # encryption key.
+ #
+ # If you are creating a new disk, this field encrypts the new disk using
+ # an encryption key that you provide. If you are attaching an existing
+ # disk that is already encrypted, this field decrypts the disk using
+ # the customer-supplied encryption key.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the
+ # same key again when you attempt to use this resource at a later time. For
+ # example, you must provide the key when you create a snapshot or an image
+ # from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted
+ # using an automatically generated key and you do not need to provide a key
+ # to use the disk later.
+ #
+ # Note:
+ #
+ # Instance templates do not storecustomer-supplied
+ # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+ #
+ # You cannot create VMs that have disks with customer-supplied keys using
+ # the bulk
+ # insert method.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "diskSizeGb": "A String", # The size of the disk in GB.
+ "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+ # currently attached to another instance. If you try to force attach a zonal
+ # disk to an instance, you will receive an error.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
+ # boot disk. If you have many disks attached to an instance, each
+ # disk would have a unique index number.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ # alongside the new instance. Use initialization parameters to create boot
+ # disks or local SSDs attached to the new instance.
+ #
+ # This field is persisted and returned for instanceTemplate and not returned
+ # in the context of instance.
+ #
+ # This property is mutually exclusive with the source property;
+ # you can only define one or the other, but not both.
+ "architecture": "A String", # The architecture of the attached disk. Valid values are
+ # arm64 or x86_64.
+ "description": "A String", # An optional description. Provide this property when creating the disk.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+ # of the instance. If a disk with the same name already exists in the given
+ # region, the existing disk is attached to the new instance and the
+ # new disk is not created.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+ # 10 GB. If you specify a sourceImage, which is required for
+ # boot disks, the default size is the size of the sourceImage.
+ # If you do not specify a sourceImage, the default disk size
+ # is 500 GB.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+ # the default is pd-standard, specified using the full URL.
+ # For example:
+ #
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ #
+ # For a full list of acceptable values, seePersistent disk
+ # types. If you specify this field when creating a VM, you can provide
+ # either the full or partial URL. For example, the following values are
+ # valid:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType
+ #
+ #
+ # If you specify this field when creating or updating an instance template
+ # or all-instances configuration, specify the type of the disk, not the
+ # URL. For example: pd-standard.
+ "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+ # only for bootable images. Read
+ # Enabling guest operating system features to see a list of available
+ # options.
+ #
+ # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+ # separate values. Set to one or more of the following values:
+ #
+ # - VIRTIO_SCSI_MULTIQUEUE
+ # - WINDOWS
+ # - MULTI_IP_SUBNET
+ # - UEFI_COMPATIBLE
+ # - GVNIC
+ # - SEV_CAPABLE
+ # - SUSPEND_RESUME_COMPATIBLE
+ # - SEV_LIVE_MIGRATABLE_V2
+ # - SEV_SNP_CAPABLE
+ # - TDX_CAPABLE
+ # - IDPF
+ # - SNP_SVSM_CAPABLE
+ #
+ #
+ # For more information, see
+ # Enabling guest operating system features.
+ },
+ ],
+ "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+ # which is either SCSI or NVME. The default isSCSI.
+ "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+ # persistent disks.
+ "a_key": "A String",
+ },
+ "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+ # disk.
+ "A String",
+ ],
+ "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+ "A String",
+ ],
+ "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+ # more than one instance.
+ "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+ # is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+ # of I/O operations per second that the disk can handle. Values must be
+ # between 10,000 and 120,000. For more details, see theExtreme persistent
+ # disk documentation.
+ "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+ # number of throughput mb per second that the disk can handle. Values must
+ # greater than or equal to 1.
+ "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+ # the URLs of the zones where the disk should be replicated to.
+ # You must provide exactly two replica zones, and one zone must be the same
+ # as the instance zone.
+ "A String",
+ ],
+ "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ # have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+ # format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when
+ # empty.
+ "a_key": "A String",
+ },
+ "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+ # Specified using the full or partial URL. For instance template, specify
+ # only the resource policy name.
+ "A String",
+ ],
+ "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+ # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # To create a disk with one of the public operating system
+ # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+ #
+ # projects/debian-cloud/global/images/family/debian-9
+ #
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ #
+ # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+ #
+ #
+ # To create a disk with a custom image that you created, specify the
+ # image name in the following format:
+ #
+ # global/images/my-custom-image
+ #
+ #
+ # You can also specify a custom image by its image family, which returns
+ # the latest version of the image in that family. Replace the image name
+ # with family/family-name:
+ #
+ # global/images/family/my-image-family
+ #
+ #
+ # If the source image is deleted later, this field will not be set.
+ "sourceImageEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source image. Required if the source image is
+ # protected by a customer-supplied encryption key.
+ #
+ # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+ # encryption keys, so you cannot create disks for instances in a managed instance group if the
+ # source images are encrypted with your own keys.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+ # instance boot disk, one of initializeParams.sourceSnapshot
+ # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # us-central1-a/instantSnapshots/my-backup
+ #
+ #
+ # If the source instant-snapshot is deleted later, this field will not be
+ # set.
+ "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+ # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+ # is required.
+ #
+ # To create a disk with a snapshot that you created, specify the
+ # snapshot name in the following format:
+ #
+ # global/snapshots/my-backup
+ #
+ #
+ # If the source snapshot is deleted later, this field will not be set.
+ #
+ # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+ # an image instead when you create VMs using
+ # the bulk
+ # insert method.
+ "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+ # encryption key of the source snapshot.
+ "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+ # For example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ #
+ # The fully-qualifed key name may be returned for resource GET requests. For
+ # example:
+ #
+ # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+ # key_region/cryptoKeys/key
+ # /cryptoKeyVersions/1
+ "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+ # key. If absent, the Compute Engine default service account is used.
+ # For example:
+ #
+ # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+ "rawKey": "A String", # Specifies a 256-bit customer-supplied
+ # encryption key, encoded in RFC
+ # 4648 base64 to either encrypt or decrypt this resource. You can
+ # provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rawKey":
+ # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+ # customer-supplied encryption key to either encrypt or decrypt this
+ # resource. You can provide either the rawKey or thersaEncryptedKey.
+ # For example:
+ #
+ # "rsaEncryptedKey":
+ # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+ # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+ # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+ #
+ # The key must meet the following requirements before you can provide it to
+ # Compute Engine:
+ #
+ # 1. The key is wrapped using a RSA public key certificate provided by
+ # Google.
+ # 2. After being wrapped, the key must be encoded in RFC 4648 base64
+ # encoding.
+ #
+ # Gets the RSA public key certificate provided by Google at:
+ #
+ #
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] TheRFC
+ # 4648 base64 encoded SHA-256 hash of the customer-supplied
+ # encryption key that protects this resource.
+ },
+ "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+ # this as a partial or full URL to the resource. For example, the following
+ # are valid values:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+ # - projects/project/zones/zone/storagePools/storagePool
+ # - zones/zone/storagePools/storagePool
+ },
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+ # either SCSI or NVME. For most machine types, the
+ # default is SCSI. Local SSDs can use either NVME or SCSI.
+ # In certain configurations, persistent disks can use NVMe. For more
+ # information, seeAbout
+ # persistent disks.
+ "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+ "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked
+ # disk is not allowed to be detached from the instance, or to be used as the
+ # source of the snapshot creation, and the image creation. The instance with
+ # at least one locked attached disk is not allow to be used as source of
+ # machine image creation, instant snapshot creation, and not allowed to be
+ # deleted with --keep-disk parameter set to true for locked disks.
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+ # in READ_WRITE mode.
+ "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+ # field is set to PRESERVED if the LocalSSD data has been saved
+ # to a persistent location by customer request. (see the
+ # discard_local_ssd option on Stop/Suspend).
+ # Read-only in the api.
+ "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk
+ # these are public keys which are safe to store in public
+ "dbs": [ # The Key Database (db).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "dbxs": [ # The forbidden key database (dbx).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "keks": [ # The Key Exchange Key (KEK).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "pk": { # The Platform Key (PK).
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ },
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+ # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+ # is required.
+ #
+ # If desired, you can also attach existing non-root persistent disks using
+ # this property. This field is only applicable for persistent disks.
+ #
+ # Note that for InstanceTemplate, specify the disk name for zonal disk,
+ # and the URL for regional disk.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+ "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
+ # URLs to the license resource. Unlike regular licenses, user provided
+ # licenses can be modified after the disk is created.
+ "A String",
+ ],
+ },
+ ],
+ "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
+ "A String",
+ ],
+ "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+ # e.g. 'Intel Ice Lake'.
+ "rank": 42, # Preference of this instance selection. Lower number means higher
+ # preference. MIG will first try to create a VM based on the machine-type
+ # with lowest rank and fallback to next rank based on availability.
+ # Machine types and instance selections with the same rank have the same
+ # preference.
+ },
+ },
+ "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to
+ # create instances.
+ "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of
+ # more preemption than the minimum capacity user needs. MIG will create
+ # only Standard VMs until it reaches standard_capacity_base and only
+ # then will start using standard_capacity_percent_above_base to mix Spot
+ # with Standard VMs.
+ "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The
+ # remaining percentage will use Spot VMs. The percentage applies only to
+ # the capacity above standard_capacity_base.
+ },
+ },
+ "instanceGroup": "A String", # Output only. [Output Only] The URL of the Instance Group resource.
+ "instanceLifecyclePolicy": { # The repair policy for this managed instance group.
+ "defaultActionOnFailure": "A String", # The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field
+ # is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application
+ # fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed
+ # VM by recreating it. For more information, see about repairing VMs in a MIG. - DO_NOTHING: MIG
+ # does not repair a failed VM.
+ "forceUpdateOnRepair": "A String", # A bit indicating whether to forcefully apply the group's latest
+ # configuration when repairing a VM. Valid options are:
+ #
+ #
+ #
+ # - NO (default): If configuration updates are available, they are not
+ # forcefully applied during repair. Instead, configuration updates are
+ # applied according to the group's update policy.
+ #
+ # - YES: If configuration updates are available, they are applied
+ # during repair.
+ "metadataBasedReadinessSignal": { # The configuration for metadata based readiness signal sent by the
+ # instance during initialization when stopping / suspending an instance.
+ # The Instance Group Manager will wait for a signal that indicates
+ # successful initialization before stopping / suspending an instance.
+ #
+ # If a successful readiness signal is not sent before timeout, the
+ # corresponding instance will not be stopped / suspended. Instead,
+ # an error will be visible in the lastAttempt.errors field of
+ # the managed instance in the listmanagedinstances
+ # method.
+ #
+ # If metadataBasedReadinessSignal.timeoutSec is unset,
+ # the Instance Group Manager will directly proceed to suspend / stop
+ # instances, skipping initialization on them.
+ "timeoutSec": 42, # The number of seconds to wait for a readiness signal during
+ # initialization before timing out.
+ },
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
+ "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
+ "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+ # Valid values are:
+ #
+ # - NO (default): MIG cannot change a VM's zone during a
+ # repair.
+ # - YES: MIG can select a different zone for the VM during
+ # a repair.
+ },
+ },
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
+ # instance group. The group uses this template to create all new instances
+ # in the managed instance group. The templates for existing instances in the
+ # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
+ "kind": "compute#instanceGroupManager", # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
+ "listManagedInstancesResults": "A String", # Pagination behavior of the listManagedInstances API method for
+ # this managed instance group.
+ "multiMig": "A String", # URL to the multi-MIG that this Managed Instance Group belongs to.
+ "name": "A String", # The name of the managed instance group. The name must be 1-63 characters
+ # long, and comply withRFC1035.
+ "namedPorts": [ # [Output Only] Named ports configured on the Instance Groups complementary
+ # to this Instance Group Manager.
+ { # The named port. For example: <"http", 80>.
+ "name": "A String", # The name for this named port.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ "port": 42, # The port number, which can be a value between 1 and 65535.
+ },
+ ],
+ "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ # key-value pairs. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
+ # format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. For more information, seeManage tags
+ # for resources.
+ "a_key": "A String",
+ },
+ },
+ "region": "A String", # Output only. [Output Only] The URL of theregion
+ # where the managed instance group resides (for regional resources).
+ "resourcePolicies": { # Resource policies for this managed instance group.
+ "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed
+ # instance group.
+ # It can be a full or partial URL. For example, the following are
+ # all valid URLs to a workload policy:
+ #
+ #
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
+ # - projects/project/regions/region/resourcePolicies/resourcePolicy
+ # - regions/region/resourcePolicies/resourcePolicy
+ },
+ "satisfiesPzi": True or False, # Output only. [Output Only] Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. [Output Only] Reserved for future use.
+ "selfLink": "A String", # Output only. [Output Only] The URL for this managed instance group. The server defines
+ # this URL.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceAccount": "A String", # The service account to be used as credentials for all operations performed
+ # by the managed instance group on instances. The service accounts needs all
+ # permissions required to create and delete instances.
+ # By default, the service account
+ # {projectNumber}@cloudservices.gserviceaccount.com is used.
+ "standbyPolicy": { # Standby policy for stopped and suspended instances.
+ "initialDelaySec": 42, # Specifies the number of seconds that the MIG should wait to suspend or
+ # stop a VM after that VM was created. The initial delay gives the
+ # initialization script the time to prepare your VM for a quick scale out.
+ # The value of initial delay must be between 0 and 3600 seconds. The
+ # default value is 0.
+ "mode": "A String", # Defines how a MIG resumes or starts VMs from a standby pool when the
+ # group scales out. The default mode is `MANUAL`.
+ },
+ "statefulPolicy": { # Stateful configuration for this Instanced Group Manager
+ "preservedState": { # Configuration of preserved resources.
+ "disks": { # Disks created on the instances that will be preserved on instance
+ # delete, update, etc. This map is keyed with the device names of
+ # the disks.
+ "a_key": {
+ "autoDelete": "A String", # These stateful disks will never be deleted during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the disk should be deleted after it
+ # is no longer used by the group, e.g. when the given instance or
+ # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
+ },
+ },
+ "externalIPs": { # External network IPs assigned to the instances that will be preserved on
+ # instance delete, update, etc. This map is keyed with the network
+ # interface name.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ },
+ },
+ "internalIPs": { # Internal network IPs assigned to the instances that will be preserved on
+ # instance delete, update, etc. This map is keyed with the network
+ # interface name.
+ "a_key": {
+ "autoDelete": "A String", # These stateful IPs will never be released during autohealing,
+ # update or VM instance recreate operations.
+ # This flag is used to configure if the IP reservation should be deleted
+ # after it is no longer used by the group, e.g. when the given instance
+ # or the whole group is deleted.
+ },
+ },
+ },
+ },
+ "status": { # Output only. [Output Only] The status of this managed instance group.
+ "allInstancesConfig": { # Output only. [Output only] Status of all-instances configuration on the group.
+ "currentRevision": "A String", # Output only. [Output Only] Current all-instances configuration revision.
+ # This value is in RFC3339 text format.
+ "effective": True or False, # Output only. [Output Only] A bit indicating whether this configuration has
+ # been applied to all managed instances in the group.
+ },
+ "appliedAcceleratorTopologies": [ # Output only. [Output Only] The accelerator topology applied to this MIG.
+ # Currently only one accelerator topology is supported.
+ {
+ "acceleratorTopology": "A String", # Output only. [Output Only] Topology in the format of: "16x16", "4x4x4", etc.
+ # The value is the same as configured in the WorkloadPolicy.
+ "state": "A String", # Output only. [Output Only] The state of the accelerator topology.
+ "stateDetails": { # Output only. [Output Only] The result of the latest accelerator topology state
+ # check.
+ "error": { # Output only. [Output Only] Encountered errors.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "timestamp": "A String", # Output only. [Output Only] Timestamp is shown only if there is an error. The field
+ # has // RFC3339 //
+ # text format.
+ },
+ },
+ ],
+ "autoscaler": "A String", # Output only. [Output Only] The URL of theAutoscaler
+ # that targets this instance group manager.
+ "bulkInstanceOperation": { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. [Output Only] The status of bulk instance operation.
+ # targetSizePolicy.mode is set to BULK.
+ "inProgress": True or False, # Output only. [Output Only] Informs whether bulk instance operation is in progress.
+ "lastProgressCheck": { # Output only. [Output Only] Information from the last progress check of bulk instance
+ # operation.
+ "error": { # Output only. [Output Only] Errors encountered during bulk instance operation.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "timestamp": "A String", # Output only. [Output Only] Timestamp of the last progress check of bulk instance
+ # operation. Timestamp is in RFC3339 text format.
+ },
+ },
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
+ "isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
+ # stable state. A stable state means that: none of the instances in the
+ # managed instance group is currently undergoing any type of change (for
+ # example, creation, restart, or deletion); no future changes are scheduled
+ # for instances in the managed instance group; and the managed instance
+ # group itself is not being modified.
+ "stateful": { # Output only. [Output Only] Stateful status of the given Instance Group Manager.
+ "hasStatefulConfig": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
+ # has stateful configuration, that is, if you have configured any items
+ # in a stateful policy or in per-instance configs.
+ # The group might report that it has no stateful configuration even when
+ # there is still some preserved state on a managed instance, for example,
+ # if you have deleted all PICs but not yet applied those deletions.
+ "isStateful": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group
+ # has stateful configuration, that is, if you have configured any items
+ # in a stateful policy or in per-instance configs.
+ # The group might report that it has no stateful configuration even when
+ # there is still some preserved state on a managed instance, for example,
+ # if you have deleted all PICs but not yet applied those deletions. This
+ # field is deprecated in favor of has_stateful_config.
+ "perInstanceConfigs": { # Output only. [Output Only] Status of per-instance configurations on the instances.
+ "allEffective": True or False, # Output only. A bit indicating if all of the group's per-instance configurations
+ # (listed in the output of a listPerInstanceConfigs API call) have
+ # status EFFECTIVE or there are no per-instance-configs.
+ },
+ },
+ "versionTarget": { # Output only. [Output Only] A status of consistency of Instances' versions with their
+ # target version specified by version field on Instance Group
+ # Manager.
+ "isReached": True or False, # Output only. [Output Only] A bit indicating whether version target has been reached
+ # in this managed instance group, i.e. all instances are in their target
+ # version. Instances' target version are specified byversion field on Instance Group Manager.
+ },
+ },
+ "targetPools": [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
+ # apply to all of the instances in the managed instance group.
+ "A String",
+ ],
+ "targetSize": 42, # The target number of running instances for this managed instance group.
+ # You can reduce this number by using the instanceGroupManager
+ # deleteInstances or abandonInstances methods. Resizing the group also
+ # changes this number.
+ "targetSizePolicy": { # The policy that specifies how the MIG creates its VMs to achieve the target
+ # size.
+ "mode": "A String", # The mode of target size policy based on which the MIG creates its VMs
+ # individually or all at once.
+ },
+ "targetSizeUnit": "A String", # The unit of measure for the target size.
+ "targetStoppedSize": 42, # The target number of stopped instances for this managed instance group.
+ # This number changes when you:
+ #
+ # - Stop instance using the stopInstances
+ # method or start instances using the startInstances
+ # method.
+ # - Manually change the targetStoppedSize using the update
+ # method.
+ "targetSuspendedSize": 42, # The target number of suspended instances for this managed instance group.
+ # This number changes when you:
+ #
+ # - Suspend instance using the suspendInstances
+ # method or resume instances using the resumeInstances
+ # method.
+ # - Manually change the targetSuspendedSize using the update
+ # method.
+ "updatePolicy": { # The update policy for this managed instance group.
+ "disruptionMode": "A String", # Whether the boot disk is allowed to be updated with restart.
+ "instanceRedistributionType": "A String", # The
+ # instance redistribution policy for regional managed instance groups.
+ # Valid values are:
+ #
+ # - PROACTIVE (default): The group attempts to maintain an
+ # even distribution of VM instances across zones in the region.
+ # - NONE: For non-autoscaled groups, proactive
+ # redistribution is disabled.
+ "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
+ # either a fixed number or, if the group has 10 or more instances, a
+ # percentage. If you set a percentage, the number of instances is rounded
+ # if necessary. The default value for maxSurge is a fixed
+ # value equal to the number of zones in which the managed instance group
+ # operates.
+ #
+ # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
+ # process. An instance is considered available if all of the following
+ # conditions are satisfied:
+ #
+ #
+ #
+ # - The instance's status is
+ # RUNNING.
+ # - If there is a health
+ # check on the instance group, the instance's health check status
+ # must be HEALTHY at least once. If there is no health check
+ # on the group, then the instance only needs to have a status of
+ # RUNNING to be considered available.
+ #
+ #
+ # This value can be either a fixed number or, if the group has 10 or more
+ # instances, a percentage. If you set a percentage, the number of instances
+ # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
+ # in which the managed instance group operates.
+ #
+ # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance
+ # becomes available. This value must be from range [0, 3600].
+ "minimalAction": "A String", # Minimal action to be taken on an instance. Use this option to minimize
+ # disruption as much as possible or to apply a more disruptive action than
+ # is necessary.
+ #
+ # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
+ # Compute Engine performs the necessary action to execute the update.
+ # - To apply a more disruptive action than is strictly necessary, set the
+ # minimal action to RESTART or REPLACE. For
+ # example, Compute Engine does not need to restart a VM to change its
+ # metadata. But if your application reads instance metadata only when a VM
+ # is restarted, you can set the minimal action to RESTART in
+ # order to pick up metadata changes.
+ "mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance.
+ # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
+ # as much as possible. RESTART to allow actions that can be
+ # applied without instance replacing or REPLACE to allow all
+ # possible actions. If the Updater determines that the minimal update
+ # action needed is more disruptive than most disruptive allowed action you
+ # specify it will not perform the update at all.
+ "replacementMethod": "A String", # What action should be used to replace instances.
+ # See minimal_action.REPLACE
+ "type": "A String", # The type
+ # of update process. You can specify either PROACTIVE so
+ # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
+ # to update.
+ },
+ "versions": [ # Specifies the instance templates used by this managed instance group to
+ # create instances.
+ #
+ # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
+ # group. This field overrides the top-level instanceTemplate
+ # field. Read more about therelationships
+ # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
+ # remaining instances. For more information, read aboutcanary
+ # updates.
+ {
+ "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
+ # instance group. The group uses this template to create new instances in
+ # the managed instance group until the `targetSize` for this version is
+ # reached. The templates for existing instances in the group do not change
+ # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases,
+ # existing instances are updated until the `targetSize` for this version is
+ # reached.
+ "name": "A String", # Name of the version. Unique among all versions in the scope of this
+ # managed instance group.
+ "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version
+ # even if instance_template remains unchanged.
+ # Deprecated in favor of 'name'.
+ "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
+ # from the template will be equal to:
+ #
+ #
+ # - If expressed as a fixed number, the minimum of either
+ # targetSize.fixed or
+ # instanceGroupManager.targetSize is used.
+ # - if expressed as a percent, the targetSize
+ # would be (targetSize.percent/100 *
+ # InstanceGroupManager.targetSize) If there is a remainder, the
+ # number is rounded.
+ #
+ # If unset, this version will update any remaining instances not
+ # updated by another version. ReadStarting
+ # a canary update for more information.
+ "calculated": 42, # Output only. [Output Only] Absolute value of VM instances calculated based on the
+ # specific mode.
+ #
+ #
+ #
+ # - If the value is fixed, then the calculated
+ # value is equal to the fixed value.
+ # - If the value is a percent, then the
+ # calculated
+ # value is percent/100 * targetSize. For example,
+ # the calculated value of a 80% of a managed instance group
+ # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
+ # is a remainder, the number is rounded.
+ "fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
+ "percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
+ # example, specify 80 for 80%.
+ },
+ },
+ ],
+ "zone": "A String", # Output only. [Output Only] The URL of azone
+ # where the managed instance group is located (for zonal resources).
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -18208,6 +18476,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionInstanceGroups.html b/docs/dyn/compute_alpha.regionInstanceGroups.html
index de3531f..e1d2d33 100644
--- a/docs/dyn/compute_alpha.regionInstanceGroups.html
+++ b/docs/dyn/compute_alpha.regionInstanceGroups.html
@@ -754,6 +754,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html
index 6cadd95..00f58fe 100644
--- a/docs/dyn/compute_alpha.regionInstanceTemplates.html
+++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html
@@ -261,6 +261,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2860,6 +2872,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html
index cd65958..9f9efe2 100644
--- a/docs/dyn/compute_alpha.regionInstances.html
+++ b/docs/dyn/compute_alpha.regionInstances.html
@@ -1909,6 +1909,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html
index a0f644a..a01bb5b 100644
--- a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html
+++ b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html
@@ -269,6 +269,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1017,6 +1029,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionInstantSnapshots.html b/docs/dyn/compute_alpha.regionInstantSnapshots.html
index 7e0598d..7688b82 100644
--- a/docs/dyn/compute_alpha.regionInstantSnapshots.html
+++ b/docs/dyn/compute_alpha.regionInstantSnapshots.html
@@ -279,6 +279,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1143,6 +1155,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2565,6 +2589,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionMultiMigs.html b/docs/dyn/compute_alpha.regionMultiMigs.html
index e4e8ec3..7d480f1 100644
--- a/docs/dyn/compute_alpha.regionMultiMigs.html
+++ b/docs/dyn/compute_alpha.regionMultiMigs.html
@@ -260,6 +260,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -859,6 +871,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html
index be28dfc..3d55c38 100644
--- a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html
+++ b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html
@@ -314,6 +314,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -604,6 +616,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -934,6 +958,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1076,6 +1112,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1282,6 +1332,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region where
@@ -1295,6 +1359,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1649,6 +1727,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1877,6 +1967,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html
index b628784..e3a29b3 100644
--- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html
+++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html
@@ -321,6 +321,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -796,6 +808,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1079,6 +1103,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1366,6 +1402,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3869,6 +3917,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5322,6 +5382,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5622,6 +5694,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6094,6 +6178,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6377,6 +6473,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6660,6 +6768,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionNetworkPolicies.html b/docs/dyn/compute_alpha.regionNetworkPolicies.html
index ce82209..e27d67c 100644
--- a/docs/dyn/compute_alpha.regionNetworkPolicies.html
+++ b/docs/dyn/compute_alpha.regionNetworkPolicies.html
@@ -293,6 +293,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -656,6 +668,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1242,6 +1266,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1871,6 +1907,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2515,6 +2563,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2880,6 +2940,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3163,6 +3235,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3446,6 +3530,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionNotificationEndpoints.html b/docs/dyn/compute_alpha.regionNotificationEndpoints.html
index a25645e..f0ffb71 100644
--- a/docs/dyn/compute_alpha.regionNotificationEndpoints.html
+++ b/docs/dyn/compute_alpha.regionNotificationEndpoints.html
@@ -520,6 +520,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -940,6 +952,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionOperations.html b/docs/dyn/compute_alpha.regionOperations.html
index bcf220a..169b08b 100644
--- a/docs/dyn/compute_alpha.regionOperations.html
+++ b/docs/dyn/compute_alpha.regionOperations.html
@@ -264,6 +264,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -620,6 +632,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -955,6 +979,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html
index f2a7851..b4a8d3f 100644
--- a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html
+++ b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html
@@ -270,6 +270,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1740,6 +1752,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionSecurityPolicies.html b/docs/dyn/compute_alpha.regionSecurityPolicies.html
index 65df4fc..518c3eb 100644
--- a/docs/dyn/compute_alpha.regionSecurityPolicies.html
+++ b/docs/dyn/compute_alpha.regionSecurityPolicies.html
@@ -764,6 +764,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1051,6 +1063,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3372,6 +3396,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -5317,6 +5353,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6093,6 +6141,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6363,6 +6423,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6662,6 +6734,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionSnapshotSettings.html b/docs/dyn/compute_alpha.regionSnapshotSettings.html
index 94f45fa..433848a 100644
--- a/docs/dyn/compute_alpha.regionSnapshotSettings.html
+++ b/docs/dyn/compute_alpha.regionSnapshotSettings.html
@@ -320,6 +320,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html
index 5d2c34c..e638d8e 100644
--- a/docs/dyn/compute_alpha.regionSnapshots.html
+++ b/docs/dyn/compute_alpha.regionSnapshots.html
@@ -282,6 +282,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1617,6 +1629,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3274,6 +3298,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3591,6 +3627,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionSslCertificates.html b/docs/dyn/compute_alpha.regionSslCertificates.html
index 62c66ab..395ffba 100644
--- a/docs/dyn/compute_alpha.regionSslCertificates.html
+++ b/docs/dyn/compute_alpha.regionSslCertificates.html
@@ -263,6 +263,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -739,6 +751,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionSslPolicies.html b/docs/dyn/compute_alpha.regionSslPolicies.html
index e620443..af4f432 100644
--- a/docs/dyn/compute_alpha.regionSslPolicies.html
+++ b/docs/dyn/compute_alpha.regionSslPolicies.html
@@ -272,6 +272,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -448,6 +460,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -648,6 +667,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -951,6 +977,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1212,6 +1250,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -1567,6 +1612,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -1870,6 +1922,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionTargetHttpProxies.html b/docs/dyn/compute_alpha.regionTargetHttpProxies.html
index 3b5d353..a08031a 100644
--- a/docs/dyn/compute_alpha.regionTargetHttpProxies.html
+++ b/docs/dyn/compute_alpha.regionTargetHttpProxies.html
@@ -266,6 +266,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -732,6 +744,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1255,6 +1279,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html
index 8eec614..0d410b9 100644
--- a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html
+++ b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html
@@ -272,6 +272,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -934,6 +946,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1734,6 +1758,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2027,6 +2063,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2316,6 +2364,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionTargetTcpProxies.html b/docs/dyn/compute_alpha.regionTargetTcpProxies.html
index d297a98..757f2f5 100644
--- a/docs/dyn/compute_alpha.regionTargetTcpProxies.html
+++ b/docs/dyn/compute_alpha.regionTargetTcpProxies.html
@@ -263,6 +263,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -647,6 +659,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html
index f998aee..a38684e 100644
--- a/docs/dyn/compute_alpha.regionUrlMaps.html
+++ b/docs/dyn/compute_alpha.regionUrlMaps.html
@@ -264,6 +264,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7675,6 +7687,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7984,6 +8008,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -15532,6 +15568,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -19401,6 +19449,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.regionZones.html b/docs/dyn/compute_alpha.regionZones.html
index d9b6938..f5b2b04 100644
--- a/docs/dyn/compute_alpha.regionZones.html
+++ b/docs/dyn/compute_alpha.regionZones.html
@@ -250,6 +250,114 @@
# zones.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "resourceStatus": {
+ "upcomingMaintenances": [ # Output only. [Output Only] The upcoming maintenance schedule.
+ { # The periodic partial maintenance schedule includes 52 weeks worth of
+ # maintenance windows.
+ # LINT.IfChange(PeriodicPartialMaintenanceSchedule)
+ "subType": "A String", # The maintenance type in which the zone is during the given window.
+ "targetResource": "A String", # The target resource that the maintenance window is for.
+ # For example, "projects/my-project/zones/us-central1-a".
+ "type": "A String",
+ "windowEndTime": { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive).
+ # This contains a time zone.
+ #
+ # This type can represent a civil time in one of a few possible ways:
+ #
+ # * When utc_offset is set and time_zone is unset: a civil time on a calendar
+ # day with a particular offset from UTC.
+ # * When time_zone is set and utc_offset is unset: a civil time on a calendar
+ # day in a particular time zone.
+ # * When neither time_zone nor utc_offset is set: a civil time on a calendar
+ # day in local time.
+ #
+ # The date is relative to the Proleptic Gregorian Calendar.
+ #
+ # If year, month, or day are 0, the DateTime is considered not to have a
+ # specific year, month, or day respectively.
+ #
+ # This type may also be used to represent a physical time if all the date and
+ # time fields are set and either case of the `time_offset` oneof is set.
+ # Consider using `Timestamp` message for physical time instead. If your use
+ # case also would like to store the user's timezone, that can be done in
+ # another field.
+ #
+ # This type is more flexible than some applications may want. Make sure to
+ # document and validate your application's limitations.
+ "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
+ # month, or 0 if specifying a datetime without a day.
+ "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+ # to 0 (midnight). An API may choose to allow the value "24:00:00" for
+ # scenarios like business closing time.
+ "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+ "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+ # datetime without a month.
+ "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+ # 999,999,999, defaults to 0.
+ "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+ "timeZone": { # Represents a time zone from the # Time zone.
+ # [IANA Time Zone Database](https://www.iana.org/time-zones).
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+ },
+ "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
+ # For example, a UTC offset of -4:00 would be represented as
+ # { seconds: -14400 }.
+ "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
+ # datetime without a year.
+ },
+ "windowStartTime": { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window.
+ # This contains a time zone.
+ #
+ # This type can represent a civil time in one of a few possible ways:
+ #
+ # * When utc_offset is set and time_zone is unset: a civil time on a calendar
+ # day with a particular offset from UTC.
+ # * When time_zone is set and utc_offset is unset: a civil time on a calendar
+ # day in a particular time zone.
+ # * When neither time_zone nor utc_offset is set: a civil time on a calendar
+ # day in local time.
+ #
+ # The date is relative to the Proleptic Gregorian Calendar.
+ #
+ # If year, month, or day are 0, the DateTime is considered not to have a
+ # specific year, month, or day respectively.
+ #
+ # This type may also be used to represent a physical time if all the date and
+ # time fields are set and either case of the `time_offset` oneof is set.
+ # Consider using `Timestamp` message for physical time instead. If your use
+ # case also would like to store the user's timezone, that can be done in
+ # another field.
+ #
+ # This type is more flexible than some applications may want. Make sure to
+ # document and validate your application's limitations.
+ "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
+ # month, or 0 if specifying a datetime without a day.
+ "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+ # to 0 (midnight). An API may choose to allow the value "24:00:00" for
+ # scenarios like business closing time.
+ "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+ "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+ # datetime without a month.
+ "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+ # 999,999,999, defaults to 0.
+ "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+ "timeZone": { # Represents a time zone from the # Time zone.
+ # [IANA Time Zone Database](https://www.iana.org/time-zones).
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+ },
+ "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
+ # For example, a UTC offset of -4:00 would be represented as
+ # { seconds: -14400 }.
+ "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
+ # datetime without a year.
+ },
+ },
+ ],
+ },
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"status": "A String", # [Output Only] Status of the zone, either UP orDOWN.
"supportsPzs": True or False, # Output only. [Output Only] Reserved for future use.
diff --git a/docs/dyn/compute_alpha.reservationBlocks.html b/docs/dyn/compute_alpha.reservationBlocks.html
index bd4d494..2d7be0b 100644
--- a/docs/dyn/compute_alpha.reservationBlocks.html
+++ b/docs/dyn/compute_alpha.reservationBlocks.html
@@ -636,6 +636,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.reservationSlots.html b/docs/dyn/compute_alpha.reservationSlots.html
index ee2f546..4db3964 100644
--- a/docs/dyn/compute_alpha.reservationSlots.html
+++ b/docs/dyn/compute_alpha.reservationSlots.html
@@ -81,11 +81,17 @@
<code><a href="#get">get(project, zone, parentName, reservationSlot, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves information about the specified reservation slot.</p>
<p class="toc_element">
+ <code><a href="#getVersion">getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Allows customers to get SBOM versions of a reservation slot.</p>
+<p class="toc_element">
<code><a href="#list">list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of reservation slots under a single reservation.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Update a reservation slot in the specified sub-block.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -175,6 +181,312 @@
</div>
<div class="method">
+ <code class="details" id="getVersion">getVersion(project, zone, parentName, reservationSlot, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Allows customers to get SBOM versions of a reservation slot.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+ parentName: string, The name of the parent reservation and parent block. In the format of
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
+ reservationSlot: string, The name of the reservation slot.
+Name should conform to RFC1035 or be a resource ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "sbomSelections": [ # The SBOM selection to return. Duplicate values in the list will be ignored.
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
<pre>Retrieves a list of reservation slots under a single reservation.
@@ -387,4 +699,350 @@
</pre>
</div>
+<div class="method">
+ <code class="details" id="update">update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Update a reservation slot in the specified sub-block.
+
+Args:
+ project: string, The project ID for this request. (required)
+ zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+ parentName: string, The name of the sub-block resource. (required)
+ reservationSlot: string, The name of the slot resource. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a reservation slot resource.
+ "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
+ "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is
+ # defined by the server.
+ "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
+ "name": "A String", # Output only. [Output Only] The name of the reservation slot.
+ "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot.
+ "block": "A String", # The unique identifier of the capacity block within the cluster.
+ "cluster": "A String", # The cluster name of the reservation sub-block.
+ "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+ "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+ # block.
+ },
+ "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
+ "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
+ # to inherit the share settings from a parent resource.
+ "folderMap": { # A map of folder id and folder config to specify consumer projects for this
+ # shared-reservation. This is only valid when share_type's value is
+ # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
+ # Folder id should be a string of number, and without "folders/" prefix.
+ "a_key": { # Config for each folder in the share settings.
+ "folderId": "A String", # The folder ID, should be same as the key of this folder config in the
+ # parent map.
+ # Folder id should be a string of number, and without "folders/" prefix.
+ },
+ },
+ "projectMap": { # A map of project id and project config. This is only valid when
+ # share_type's value is SPECIFIC_PROJECTS.
+ "a_key": { # Config for each project in the share settings.
+ "projectId": "A String", # The project ID, should be same as the key of this project config in the
+ # parent map.
+ },
+ },
+ "projects": [ # A List of Project names to specify consumer projects for this
+ # shared-reservation. This is only valid when share_type's value is
+ # SPECIFIC_PROJECTS.
+ "A String",
+ ],
+ "shareType": "A String", # Type of sharing for this shared-reservation
+ },
+ "state": "A String", # Output only. [Output Only] The state of the reservation slot.
+ "status": { # Output only. [Output Only] The status of the reservation slot.
+ "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block.
+ "block": "A String", # The unique identifier of the capacity block within the cluster.
+ "cluster": "A String", # The cluster name of the reservation sub-block.
+ "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+ "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+ # block.
+ },
+ "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host.
+ "A String",
+ ],
+ "runningInstances": [ # Output only. The URIs of the instances currently running on this slot.
+ "A String",
+ ],
+ },
+ "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides.
+}
+
+ updateMask: string, The fields to be updated as part of this request.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.reservationSubBlocks.html b/docs/dyn/compute_alpha.reservationSubBlocks.html
index ef9540c..ef18e3a 100644
--- a/docs/dyn/compute_alpha.reservationSubBlocks.html
+++ b/docs/dyn/compute_alpha.reservationSubBlocks.html
@@ -81,6 +81,9 @@
<code><a href="#get">get(project, zone, parentName, reservationSubBlock, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves information about the specified reservation subBlock.</p>
<p class="toc_element">
+ <code><a href="#getVersion">getVersion(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Allows customers to get SBOM versions of a reservation subBlock.</p>
+<p class="toc_element">
<code><a href="#list">list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of reservation subBlocks under a single reservation.</p>
<p class="toc_element">
@@ -220,6 +223,312 @@
</div>
<div class="method">
+ <code class="details" id="getVersion">getVersion(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Allows customers to get SBOM versions of a reservation subBlock.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+ parentName: string, The name of the parent reservation and parent block. In the format of
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name} (required)
+ reservationSubBlock: string, The name of the reservation subBlock.
+Name should conform to RFC1035 or be a resource ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "sbomSelections": [ # The SBOM selection to return.
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
<pre>Retrieves a list of reservation subBlocks under a single reservation.
@@ -631,6 +940,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -930,6 +1251,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html
index a37ef5f..63ebfda 100644
--- a/docs/dyn/compute_alpha.reservations.html
+++ b/docs/dyn/compute_alpha.reservations.html
@@ -272,6 +272,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -292,6 +293,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -440,7 +444,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -748,6 +752,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -925,6 +941,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -945,6 +962,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1093,7 +1113,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1576,6 +1596,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -1596,6 +1617,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1744,7 +1768,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1959,6 +1983,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2223,6 +2259,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -2243,6 +2280,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2391,7 +2431,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2672,6 +2712,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2964,6 +3016,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4045,6 +4109,7 @@
},
"commitment": "A String", # Output only. [Output Only] Full or partial URL to a parent commitment. This field
# displays for reservations that are tied to a commitment.
+ "confidentialComputeType": "A String",
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"deleteAfterDuration": { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
@@ -4065,6 +4130,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -4213,7 +4281,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -4430,6 +4498,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html
index cfcff21..1940fa2 100644
--- a/docs/dyn/compute_alpha.resourcePolicies.html
+++ b/docs/dyn/compute_alpha.resourcePolicies.html
@@ -634,6 +634,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1626,6 +1638,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2388,6 +2412,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.rolloutPlans.html b/docs/dyn/compute_alpha.rolloutPlans.html
index 00ae363..d459fb8 100644
--- a/docs/dyn/compute_alpha.rolloutPlans.html
+++ b/docs/dyn/compute_alpha.rolloutPlans.html
@@ -259,6 +259,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -750,6 +762,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.rollouts.html b/docs/dyn/compute_alpha.rollouts.html
index 24e89af..5f06572 100644
--- a/docs/dyn/compute_alpha.rollouts.html
+++ b/docs/dyn/compute_alpha.rollouts.html
@@ -92,6 +92,12 @@
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#pause">pause(project, rollout, etag=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Pauses a Rollout.</p>
+<p class="toc_element">
+ <code><a href="#resume">resume(project, rollout, etag=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Resumes a Rollout.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(project, rollout, requestId=None, rollback=None, x__xgafv=None)</code>
@@ -258,6 +264,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -544,6 +562,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -985,4 +1015,596 @@
</pre>
</div>
+<div class="method">
+ <code class="details" id="pause">pause(project, rollout, etag=None, requestId=None, x__xgafv=None)</code>
+ <pre>Pauses a Rollout.
+
+Args:
+ project: string, Required. Project ID for this request. (required)
+ rollout: string, Required. Name of the Rollout resource to pause. (required)
+ etag: string, The etag of the Rollout.
+If this is provided, the request will only succeed if the etag matches
+the current etag of the Rollout.
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="resume">resume(project, rollout, etag=None, requestId=None, x__xgafv=None)</code>
+ <pre>Resumes a Rollout.
+
+Args:
+ project: string, Required. Project ID for this request. (required)
+ rollout: string, Required. Name of the Rollout resource to resume. (required)
+ etag: string, The etag of the Rollout.
+If this is provided, the request will only succeed if the etag matches
+the current etag of the Rollout.
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `[email protected]` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html
index f8986a1..161ea10 100644
--- a/docs/dyn/compute_alpha.routers.html
+++ b/docs/dyn/compute_alpha.routers.html
@@ -1064,6 +1064,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1347,6 +1359,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1630,6 +1654,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4225,6 +4261,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6427,6 +6475,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6772,6 +6832,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7167,6 +7239,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -9126,6 +9210,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -9471,6 +9567,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -9866,6 +9974,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.routes.html b/docs/dyn/compute_alpha.routes.html
index 820bbef..942b604 100644
--- a/docs/dyn/compute_alpha.routes.html
+++ b/docs/dyn/compute_alpha.routes.html
@@ -262,6 +262,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -904,6 +916,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.securityPolicies.html b/docs/dyn/compute_alpha.securityPolicies.html
index 7e2ffc6..4b949dd 100644
--- a/docs/dyn/compute_alpha.securityPolicies.html
+++ b/docs/dyn/compute_alpha.securityPolicies.html
@@ -775,6 +775,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2008,6 +2020,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4326,6 +4350,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6403,6 +6439,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7178,6 +7226,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7447,6 +7507,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -7735,6 +7807,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.serviceAttachments.html b/docs/dyn/compute_alpha.serviceAttachments.html
index a105b7e..6f51d65 100644
--- a/docs/dyn/compute_alpha.serviceAttachments.html
+++ b/docs/dyn/compute_alpha.serviceAttachments.html
@@ -618,6 +618,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1580,6 +1592,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2309,6 +2333,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.snapshotGroups.html b/docs/dyn/compute_alpha.snapshotGroups.html
index 4a1c022..aa34a67 100644
--- a/docs/dyn/compute_alpha.snapshotGroups.html
+++ b/docs/dyn/compute_alpha.snapshotGroups.html
@@ -268,6 +268,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1002,6 +1014,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html b/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html
index 2e17420..246c322 100644
--- a/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html
+++ b/docs/dyn/compute_alpha.snapshotRecycleBinPolicy.html
@@ -318,6 +318,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.snapshotSettings.html b/docs/dyn/compute_alpha.snapshotSettings.html
index a241305..0ece668 100644
--- a/docs/dyn/compute_alpha.snapshotSettings.html
+++ b/docs/dyn/compute_alpha.snapshotSettings.html
@@ -318,6 +318,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html
index 3a550c2..ad53be0 100644
--- a/docs/dyn/compute_alpha.snapshots.html
+++ b/docs/dyn/compute_alpha.snapshots.html
@@ -819,6 +819,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2176,6 +2188,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3819,6 +3843,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4134,6 +4170,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.sslCertificates.html b/docs/dyn/compute_alpha.sslCertificates.html
index b064814..62d2e03 100644
--- a/docs/dyn/compute_alpha.sslCertificates.html
+++ b/docs/dyn/compute_alpha.sslCertificates.html
@@ -550,6 +550,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1022,6 +1034,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.sslPolicies.html b/docs/dyn/compute_alpha.sslPolicies.html
index e844a04..25d624d 100644
--- a/docs/dyn/compute_alpha.sslPolicies.html
+++ b/docs/dyn/compute_alpha.sslPolicies.html
@@ -263,6 +263,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -661,6 +668,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -836,6 +855,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -1034,6 +1060,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -1337,6 +1370,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1597,6 +1642,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -1950,6 +2002,13 @@
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
+ "postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows
+ # negotiating X25519MLKEM768 key exchange when clients advertise support for
+ # it. When set to DEFAULT, or if no SSL Policy is
+ # attached to the target proxy, the load balancer disallows X25519MLKEM768
+ # key exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key
+ # exchange. Customers can set this to DEFERRED to temporarily
+ # opt-out the LB from negotiating post-quantum key exchange by default.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features
# to enable must be specified in the customFeatures field.
@@ -2253,6 +2312,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.storagePools.html b/docs/dyn/compute_alpha.storagePools.html
index 743fbde..ff67b21 100644
--- a/docs/dyn/compute_alpha.storagePools.html
+++ b/docs/dyn/compute_alpha.storagePools.html
@@ -631,6 +631,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1591,6 +1603,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3242,6 +3266,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3710,6 +3746,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html
index 558e68e..ba2fc43 100644
--- a/docs/dyn/compute_alpha.subnetworks.html
+++ b/docs/dyn/compute_alpha.subnetworks.html
@@ -773,6 +773,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1065,6 +1077,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2304,6 +2328,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3547,6 +3583,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -4712,6 +4760,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetGrpcProxies.html b/docs/dyn/compute_alpha.targetGrpcProxies.html
index c7a7f46..5f1cca8 100644
--- a/docs/dyn/compute_alpha.targetGrpcProxies.html
+++ b/docs/dyn/compute_alpha.targetGrpcProxies.html
@@ -265,6 +265,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -655,6 +667,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1181,6 +1205,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetHttpProxies.html b/docs/dyn/compute_alpha.targetHttpProxies.html
index cc806ee..c41cbab 100644
--- a/docs/dyn/compute_alpha.targetHttpProxies.html
+++ b/docs/dyn/compute_alpha.targetHttpProxies.html
@@ -552,6 +552,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1016,6 +1028,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1618,6 +1642,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1906,6 +1942,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetHttpsProxies.html b/docs/dyn/compute_alpha.targetHttpsProxies.html
index ed9d2ee..535f563 100644
--- a/docs/dyn/compute_alpha.targetHttpsProxies.html
+++ b/docs/dyn/compute_alpha.targetHttpsProxies.html
@@ -662,6 +662,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1322,6 +1334,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2120,6 +2144,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2411,6 +2447,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2700,6 +2748,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2994,6 +3054,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3287,6 +3359,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3576,6 +3660,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetInstances.html b/docs/dyn/compute_alpha.targetInstances.html
index b5d2273..092b6f6 100644
--- a/docs/dyn/compute_alpha.targetInstances.html
+++ b/docs/dyn/compute_alpha.targetInstances.html
@@ -510,6 +510,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -900,6 +912,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1387,6 +1411,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetPools.html b/docs/dyn/compute_alpha.targetPools.html
index 9de916b..970436a 100644
--- a/docs/dyn/compute_alpha.targetPools.html
+++ b/docs/dyn/compute_alpha.targetPools.html
@@ -301,6 +301,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -600,6 +612,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1157,6 +1181,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1661,6 +1697,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2191,6 +2239,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2485,6 +2545,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2775,6 +2847,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -3067,6 +3151,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetSslProxies.html b/docs/dyn/compute_alpha.targetSslProxies.html
index e328936..4e441ad 100644
--- a/docs/dyn/compute_alpha.targetSslProxies.html
+++ b/docs/dyn/compute_alpha.targetSslProxies.html
@@ -277,6 +277,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -663,6 +675,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1145,6 +1169,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1436,6 +1472,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1725,6 +1773,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2018,6 +2078,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2311,6 +2383,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetTcpProxies.html b/docs/dyn/compute_alpha.targetTcpProxies.html
index 0ba2845..e02b59b 100644
--- a/docs/dyn/compute_alpha.targetTcpProxies.html
+++ b/docs/dyn/compute_alpha.targetTcpProxies.html
@@ -511,6 +511,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -893,6 +905,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1373,6 +1397,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1662,6 +1698,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.targetVpnGateways.html b/docs/dyn/compute_alpha.targetVpnGateways.html
index 1a956a0..8b0cbb1 100644
--- a/docs/dyn/compute_alpha.targetVpnGateways.html
+++ b/docs/dyn/compute_alpha.targetVpnGateways.html
@@ -537,6 +537,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -981,6 +993,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1501,6 +1525,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html
index 7ae0b92..b049f2d 100644
--- a/docs/dyn/compute_alpha.urlMaps.html
+++ b/docs/dyn/compute_alpha.urlMaps.html
@@ -4035,6 +4035,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -11455,6 +11467,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -11774,6 +11798,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -19331,6 +19367,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -23209,6 +23257,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.vpnGateways.html b/docs/dyn/compute_alpha.vpnGateways.html
index 59af793..faed38e 100644
--- a/docs/dyn/compute_alpha.vpnGateways.html
+++ b/docs/dyn/compute_alpha.vpnGateways.html
@@ -560,6 +560,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1093,6 +1105,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1633,6 +1657,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.vpnTunnels.html b/docs/dyn/compute_alpha.vpnTunnels.html
index 4d0d3ad..6878455 100644
--- a/docs/dyn/compute_alpha.vpnTunnels.html
+++ b/docs/dyn/compute_alpha.vpnTunnels.html
@@ -634,6 +634,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1270,6 +1282,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1887,6 +1911,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.wireGroups.html b/docs/dyn/compute_alpha.wireGroups.html
index 382e266..bbf3af5 100644
--- a/docs/dyn/compute_alpha.wireGroups.html
+++ b/docs/dyn/compute_alpha.wireGroups.html
@@ -264,6 +264,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1018,6 +1030,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1914,6 +1938,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.zoneFolderOperations.html b/docs/dyn/compute_alpha.zoneFolderOperations.html
index ca5af2b..2df61f2 100644
--- a/docs/dyn/compute_alpha.zoneFolderOperations.html
+++ b/docs/dyn/compute_alpha.zoneFolderOperations.html
@@ -241,6 +241,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -597,6 +609,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.zoneOperations.html b/docs/dyn/compute_alpha.zoneOperations.html
index 0c2e28c..97d9124 100644
--- a/docs/dyn/compute_alpha.zoneOperations.html
+++ b/docs/dyn/compute_alpha.zoneOperations.html
@@ -264,6 +264,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -620,6 +632,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -954,6 +978,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.zoneOrganizationOperations.html b/docs/dyn/compute_alpha.zoneOrganizationOperations.html
index bac5ad9..a54db66 100644
--- a/docs/dyn/compute_alpha.zoneOrganizationOperations.html
+++ b/docs/dyn/compute_alpha.zoneOrganizationOperations.html
@@ -242,6 +242,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -598,6 +610,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html
index 392791a..b8a12c3 100644
--- a/docs/dyn/compute_alpha.zoneQueuedResources.html
+++ b/docs/dyn/compute_alpha.zoneQueuedResources.html
@@ -2289,6 +2289,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -2580,6 +2592,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -6537,6 +6561,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html b/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html
index 067b366..5d85f63 100644
--- a/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html
+++ b/docs/dyn/compute_alpha.zoneVmExtensionPolicies.html
@@ -272,6 +272,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -715,6 +727,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
@@ -1446,6 +1470,18 @@
},
],
},
+ "getVersionOperationMetadata": {
+ "inlineSbomInfo": {
+ "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component
+ # name and the value is the version.
+ "a_key": "A String",
+ },
+ "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the
+ # component name and the value is the version.
+ "a_key": "A String",
+ },
+ },
+ },
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
diff --git a/docs/dyn/compute_alpha.zones.html b/docs/dyn/compute_alpha.zones.html
index d5eb7d5..6f6f36a 100644
--- a/docs/dyn/compute_alpha.zones.html
+++ b/docs/dyn/compute_alpha.zones.html
@@ -166,6 +166,114 @@
# zones.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "resourceStatus": {
+ "upcomingMaintenances": [ # Output only. [Output Only] The upcoming maintenance schedule.
+ { # The periodic partial maintenance schedule includes 52 weeks worth of
+ # maintenance windows.
+ # LINT.IfChange(PeriodicPartialMaintenanceSchedule)
+ "subType": "A String", # The maintenance type in which the zone is during the given window.
+ "targetResource": "A String", # The target resource that the maintenance window is for.
+ # For example, "projects/my-project/zones/us-central1-a".
+ "type": "A String",
+ "windowEndTime": { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive).
+ # This contains a time zone.
+ #
+ # This type can represent a civil time in one of a few possible ways:
+ #
+ # * When utc_offset is set and time_zone is unset: a civil time on a calendar
+ # day with a particular offset from UTC.
+ # * When time_zone is set and utc_offset is unset: a civil time on a calendar
+ # day in a particular time zone.
+ # * When neither time_zone nor utc_offset is set: a civil time on a calendar
+ # day in local time.
+ #
+ # The date is relative to the Proleptic Gregorian Calendar.
+ #
+ # If year, month, or day are 0, the DateTime is considered not to have a
+ # specific year, month, or day respectively.
+ #
+ # This type may also be used to represent a physical time if all the date and
+ # time fields are set and either case of the `time_offset` oneof is set.
+ # Consider using `Timestamp` message for physical time instead. If your use
+ # case also would like to store the user's timezone, that can be done in
+ # another field.
+ #
+ # This type is more flexible than some applications may want. Make sure to
+ # document and validate your application's limitations.
+ "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
+ # month, or 0 if specifying a datetime without a day.
+ "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+ # to 0 (midnight). An API may choose to allow the value "24:00:00" for
+ # scenarios like business closing time.
+ "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+ "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+ # datetime without a month.
+ "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+ # 999,999,999, defaults to 0.
+ "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+ "timeZone": { # Represents a time zone from the # Time zone.
+ # [IANA Time Zone Database](https://www.iana.org/time-zones).
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+ },
+ "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
+ # For example, a UTC offset of -4:00 would be represented as
+ # { seconds: -14400 }.
+ "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
+ # datetime without a year.
+ },
+ "windowStartTime": { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window.
+ # This contains a time zone.
+ #
+ # This type can represent a civil time in one of a few possible ways:
+ #
+ # * When utc_offset is set and time_zone is unset: a civil time on a calendar
+ # day with a particular offset from UTC.
+ # * When time_zone is set and utc_offset is unset: a civil time on a calendar
+ # day in a particular time zone.
+ # * When neither time_zone nor utc_offset is set: a civil time on a calendar
+ # day in local time.
+ #
+ # The date is relative to the Proleptic Gregorian Calendar.
+ #
+ # If year, month, or day are 0, the DateTime is considered not to have a
+ # specific year, month, or day respectively.
+ #
+ # This type may also be used to represent a physical time if all the date and
+ # time fields are set and either case of the `time_offset` oneof is set.
+ # Consider using `Timestamp` message for physical time instead. If your use
+ # case also would like to store the user's timezone, that can be done in
+ # another field.
+ #
+ # This type is more flexible than some applications may want. Make sure to
+ # document and validate your application's limitations.
+ "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
+ # month, or 0 if specifying a datetime without a day.
+ "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+ # to 0 (midnight). An API may choose to allow the value "24:00:00" for
+ # scenarios like business closing time.
+ "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+ "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+ # datetime without a month.
+ "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+ # 999,999,999, defaults to 0.
+ "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+ "timeZone": { # Represents a time zone from the # Time zone.
+ # [IANA Time Zone Database](https://www.iana.org/time-zones).
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+ },
+ "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
+ # For example, a UTC offset of -4:00 would be represented as
+ # { seconds: -14400 }.
+ "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
+ # datetime without a year.
+ },
+ },
+ ],
+ },
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"status": "A String", # [Output Only] Status of the zone, either UP orDOWN.
"supportsPzs": True or False, # Output only. [Output Only] Reserved for future use.
@@ -331,6 +439,114 @@
# zones.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] Full URL reference to the region which hosts the zone.
+ "resourceStatus": {
+ "upcomingMaintenances": [ # Output only. [Output Only] The upcoming maintenance schedule.
+ { # The periodic partial maintenance schedule includes 52 weeks worth of
+ # maintenance windows.
+ # LINT.IfChange(PeriodicPartialMaintenanceSchedule)
+ "subType": "A String", # The maintenance type in which the zone is during the given window.
+ "targetResource": "A String", # The target resource that the maintenance window is for.
+ # For example, "projects/my-project/zones/us-central1-a".
+ "type": "A String",
+ "windowEndTime": { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive).
+ # This contains a time zone.
+ #
+ # This type can represent a civil time in one of a few possible ways:
+ #
+ # * When utc_offset is set and time_zone is unset: a civil time on a calendar
+ # day with a particular offset from UTC.
+ # * When time_zone is set and utc_offset is unset: a civil time on a calendar
+ # day in a particular time zone.
+ # * When neither time_zone nor utc_offset is set: a civil time on a calendar
+ # day in local time.
+ #
+ # The date is relative to the Proleptic Gregorian Calendar.
+ #
+ # If year, month, or day are 0, the DateTime is considered not to have a
+ # specific year, month, or day respectively.
+ #
+ # This type may also be used to represent a physical time if all the date and
+ # time fields are set and either case of the `time_offset` oneof is set.
+ # Consider using `Timestamp` message for physical time instead. If your use
+ # case also would like to store the user's timezone, that can be done in
+ # another field.
+ #
+ # This type is more flexible than some applications may want. Make sure to
+ # document and validate your application's limitations.
+ "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
+ # month, or 0 if specifying a datetime without a day.
+ "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+ # to 0 (midnight). An API may choose to allow the value "24:00:00" for
+ # scenarios like business closing time.
+ "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+ "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+ # datetime without a month.
+ "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+ # 999,999,999, defaults to 0.
+ "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+ "timeZone": { # Represents a time zone from the # Time zone.
+ # [IANA Time Zone Database](https://www.iana.org/time-zones).
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+ },
+ "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
+ # For example, a UTC offset of -4:00 would be represented as
+ # { seconds: -14400 }.
+ "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
+ # datetime without a year.
+ },
+ "windowStartTime": { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window.
+ # This contains a time zone.
+ #
+ # This type can represent a civil time in one of a few possible ways:
+ #
+ # * When utc_offset is set and time_zone is unset: a civil time on a calendar
+ # day with a particular offset from UTC.
+ # * When time_zone is set and utc_offset is unset: a civil time on a calendar
+ # day in a particular time zone.
+ # * When neither time_zone nor utc_offset is set: a civil time on a calendar
+ # day in local time.
+ #
+ # The date is relative to the Proleptic Gregorian Calendar.
+ #
+ # If year, month, or day are 0, the DateTime is considered not to have a
+ # specific year, month, or day respectively.
+ #
+ # This type may also be used to represent a physical time if all the date and
+ # time fields are set and either case of the `time_offset` oneof is set.
+ # Consider using `Timestamp` message for physical time instead. If your use
+ # case also would like to store the user's timezone, that can be done in
+ # another field.
+ #
+ # This type is more flexible than some applications may want. Make sure to
+ # document and validate your application's limitations.
+ "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
+ # month, or 0 if specifying a datetime without a day.
+ "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
+ # to 0 (midnight). An API may choose to allow the value "24:00:00" for
+ # scenarios like business closing time.
+ "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+ "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
+ # datetime without a month.
+ "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
+ # 999,999,999, defaults to 0.
+ "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
+ # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+ "timeZone": { # Represents a time zone from the # Time zone.
+ # [IANA Time Zone Database](https://www.iana.org/time-zones).
+ "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+ },
+ "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
+ # For example, a UTC offset of -4:00 would be represented as
+ # { seconds: -14400 }.
+ "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
+ # datetime without a year.
+ },
+ },
+ ],
+ },
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"status": "A String", # [Output Only] Status of the zone, either UP orDOWN.
"supportsPzs": True or False, # Output only. [Output Only] Reserved for future use.
diff --git a/docs/dyn/compute_beta.futureReservations.html b/docs/dyn/compute_beta.futureReservations.html
index 5cd8dfc..94f9793 100644
--- a/docs/dyn/compute_beta.futureReservations.html
+++ b/docs/dyn/compute_beta.futureReservations.html
@@ -221,6 +221,11 @@
"a_key": { # Name of the scope containing this set of future reservations.
"futureReservations": [ # A list of future reservations contained in this scope.
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -342,7 +347,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -431,7 +436,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1191,6 +1196,11 @@
An object of the form:
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -1312,7 +1322,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1401,7 +1411,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1508,6 +1518,11 @@
The object takes the form of:
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -1629,7 +1644,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1718,7 +1733,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2191,6 +2206,11 @@
# defined by the server.
"items": [ # [Output Only] A list of future reservation resources.
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -2312,7 +2332,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2401,7 +2421,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2561,6 +2581,11 @@
The object takes the form of:
{
+ "advancedDeploymentControl": { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
+ # deployment type future reservations.
+ # type reservations.
+ "reservationOperationalMode": "A String", # Indicates chosen reservation operational mode for the reservation.
+ },
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total # Aggregate reservation details for the future reservation.
# count of CPUs) and can account for multiple instance SKUs. In other words,
# one can create instances of varying shapes against this reservation.
@@ -2682,7 +2707,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2771,7 +2796,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
diff --git a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
index afe2432..a02c25a 100644
--- a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
+++ b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
@@ -1062,6 +1062,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1266,6 +1280,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
body: object, The request body.
@@ -1276,6 +1304,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1853,6 +1895,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html
index 5156466..2339673 100644
--- a/docs/dyn/compute_beta.instanceGroupManagers.html
+++ b/docs/dyn/compute_beta.instanceGroupManagers.html
@@ -1492,6 +1492,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -4263,6 +4302,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -5425,6 +5503,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -6911,6 +7028,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -9356,6 +9512,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -14245,6 +14440,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html
index 98fe374..f270eec 100644
--- a/docs/dyn/compute_beta.instanceTemplates.html
+++ b/docs/dyn/compute_beta.instanceTemplates.html
@@ -902,6 +902,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1158,6 +1160,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -1207,6 +1224,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -2317,6 +2338,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2573,6 +2596,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -2622,6 +2660,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -3730,6 +3772,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -3986,6 +4030,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -4035,6 +4094,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -5140,6 +5203,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -5396,6 +5461,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -5445,6 +5525,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html
index f479a10..fea56f0 100644
--- a/docs/dyn/compute_beta.instances.html
+++ b/docs/dyn/compute_beta.instances.html
@@ -657,6 +657,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2217,6 +2219,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2402,6 +2406,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -2568,6 +2573,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -2692,6 +2712,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -4726,6 +4750,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -4982,6 +5008,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -5031,6 +5072,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
# bulk.
@@ -7287,6 +7332,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -7472,6 +7519,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -7638,6 +7686,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -7762,6 +7825,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -10182,6 +10249,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -10367,6 +10436,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -10533,6 +10603,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -10657,6 +10742,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -11821,6 +11910,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -12006,6 +12097,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -12172,6 +12264,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -12296,6 +12403,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -17731,6 +17842,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -21805,6 +21931,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -21990,6 +22118,7 @@
"enableOsInventoryMetadataValue": True or False, # Effective enable-os-inventory value at Instance level.
"enableOsconfigMetadataValue": True or False, # Effective enable-osconfig value at Instance level.
"enableOsloginMetadataValue": True or False, # Effective enable-oslogin value at Instance level.
+ "gceContainerDeclarationMetadataValue": True or False, # Effective gce-container-declaration value at Instance level.
"serialPortEnableMetadataValue": True or False, # Effective serial-port-enable value at Instance level.
"serialPortLoggingEnableMetadataValue": True or False, # Effective serial-port-logging-enable value at Instance level.
"vmDnsSettingMetadataValue": "A String", # Effective VM DNS setting at Instance level.
@@ -22156,6 +22285,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -22280,6 +22424,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -23278,6 +23426,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
diff --git a/docs/dyn/compute_beta.instantSnapshots.html b/docs/dyn/compute_beta.instantSnapshots.html
index 88b287e..201d455 100644
--- a/docs/dyn/compute_beta.instantSnapshots.html
+++ b/docs/dyn/compute_beta.instantSnapshots.html
@@ -259,6 +259,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -732,6 +744,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -1195,6 +1219,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -1653,6 +1689,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html
index 4c25d4c..3afa952 100644
--- a/docs/dyn/compute_beta.interconnects.html
+++ b/docs/dyn/compute_beta.interconnects.html
@@ -680,8 +680,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -1124,8 +1123,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -1777,8 +1775,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -2119,8 +2116,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html
index b394467..93870f7 100644
--- a/docs/dyn/compute_beta.machineImages.html
+++ b/docs/dyn/compute_beta.machineImages.html
@@ -1067,6 +1067,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1323,6 +1325,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -1372,6 +1389,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -1804,6 +1825,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2019,6 +2042,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -3106,6 +3144,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -3362,6 +3402,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -3411,6 +3466,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -3843,6 +3902,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -4058,6 +4119,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -5138,6 +5214,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -5394,6 +5472,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -5443,6 +5536,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -5875,6 +5972,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -6090,6 +6189,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
diff --git a/docs/dyn/compute_beta.networkEndpointGroups.html b/docs/dyn/compute_beta.networkEndpointGroups.html
index faeb161..72f614d 100644
--- a/docs/dyn/compute_beta.networkEndpointGroups.html
+++ b/docs/dyn/compute_beta.networkEndpointGroups.html
@@ -234,6 +234,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1481,6 +1495,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1685,6 +1713,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone where
@@ -1698,6 +1740,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -2277,6 +2333,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html
index d3ac79d..ba5febc 100644
--- a/docs/dyn/compute_beta.regionCommitments.html
+++ b/docs/dyn/compute_beta.regionCommitments.html
@@ -351,6 +351,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -455,7 +458,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -809,6 +812,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -913,7 +919,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1177,6 +1183,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1281,7 +1290,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1908,6 +1917,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2012,7 +2024,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2361,6 +2373,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2465,7 +2480,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2935,6 +2950,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -3039,7 +3057,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
index 1315563..511185e 100644
--- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
@@ -3301,6 +3301,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -4430,6 +4469,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -5915,6 +5993,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -8352,6 +8469,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
@@ -13207,6 +13363,45 @@
# operation. Timestamp is in RFC3339 text format.
},
},
+ "currentInstanceStatuses": { # The list of instance statuses and the number of instances in this managed # Output only. [Output Only] The list of instance statuses and the number of instances
+ # in this managed instance group that have the status. Currently only shown
+ # for TPU MIGs
+ # instance group that have the status. For more information about how to
+ # interpret each status check the instance lifecycle documentation.
+ # Currently only shown for TPU MIGs.
+ "deprovisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have DEPROVISIONING status.
+ "nonExistent": 42, # Output only. [Output Only] The number of instances that have not been created yet or
+ # have been deleted. Includes only instances that would be shown in the
+ # listManagedInstances method and not all instances that have been
+ # deleted in the lifetime of the MIG.
+ # Does not include FlexStart instances that are waiting for the resources
+ # availability, they are considered as 'pending'.
+ "pending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING status, that is FlexStart instances that are waiting
+ # for resources. Instances that do not exist because of the other reasons
+ # are counted as 'non_existent'.
+ "pendingStop": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PENDING_STOP status.
+ "provisioning": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have PROVISIONING status.
+ "repairing": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have REPAIRING status.
+ "running": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have RUNNING status.
+ "staging": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STAGING status.
+ "stopped": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPED status.
+ "stopping": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have STOPPING status.
+ "suspended": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDED status.
+ "suspending": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have SUSPENDING status.
+ "terminated": 42, # Output only. [Output Only] The number of instances in the managed instance group
+ # that have TERMINATED status.
+ },
"isStable": True or False, # Output only. [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the
# managed instance group is currently undergoing any type of change (for
diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html
index ea4fb76..0ecee48 100644
--- a/docs/dyn/compute_beta.regionInstanceTemplates.html
+++ b/docs/dyn/compute_beta.regionInstanceTemplates.html
@@ -1079,6 +1079,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1335,6 +1337,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -1384,6 +1401,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -2122,6 +2143,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2378,6 +2401,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -2427,6 +2465,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -3533,6 +3575,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -3789,6 +3833,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -3838,6 +3897,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html
index e6bc283..925758b 100644
--- a/docs/dyn/compute_beta.regionInstances.html
+++ b/docs/dyn/compute_beta.regionInstances.html
@@ -1257,6 +1257,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1513,6 +1515,21 @@
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
+ "preemptionNoticeDuration": { # A Duration represents a fixed-length span of time represented # Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft
+ # Off signal is triggered for Spot
+ # VMs only. If not specified, there will be no wait before the G2 Soft
+ # Off signal is triggered.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
@@ -1562,6 +1579,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
# bulk.
diff --git a/docs/dyn/compute_beta.regionInstantSnapshots.html b/docs/dyn/compute_beta.regionInstantSnapshots.html
index 458c38a..ed7d4da 100644
--- a/docs/dyn/compute_beta.regionInstantSnapshots.html
+++ b/docs/dyn/compute_beta.regionInstantSnapshots.html
@@ -448,6 +448,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -911,6 +923,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -1369,6 +1393,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
diff --git a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html
index 08b3b21..d6fc246 100644
--- a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html
+++ b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html
@@ -1073,6 +1073,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1277,6 +1291,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region where
@@ -1290,6 +1318,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1869,6 +1911,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html
index 8b336d3..0d9d176 100644
--- a/docs/dyn/compute_beta.regionUrlMaps.html
+++ b/docs/dyn/compute_beta.regionUrlMaps.html
@@ -542,6 +542,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -1177,6 +1379,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -1793,6 +2197,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -2671,6 +3277,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -3300,6 +4108,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -3935,6 +4945,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -4551,6 +5763,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -5429,6 +6843,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -6707,6 +8323,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -7342,6 +9160,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -7958,6 +9978,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -8836,6 +11058,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -9516,6 +11940,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -10151,6 +12777,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -10767,6 +13595,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -11645,6 +14675,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -12570,6 +15802,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -13205,6 +16639,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -13821,6 +17457,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -14699,6 +18537,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -15592,6 +19632,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -16227,6 +20469,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -16843,6 +21287,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -17721,6 +22367,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html
index d3f572a..d35d236 100644
--- a/docs/dyn/compute_beta.reservations.html
+++ b/docs/dyn/compute_beta.reservations.html
@@ -292,6 +292,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -396,7 +399,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -900,6 +903,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1004,7 +1010,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1507,6 +1513,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1611,7 +1620,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2109,6 +2118,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2213,7 +2225,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -3885,6 +3897,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -3989,7 +4004,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html
index fd07908..b8dac93 100644
--- a/docs/dyn/compute_beta.urlMaps.html
+++ b/docs/dyn/compute_beta.urlMaps.html
@@ -372,6 +372,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -1007,6 +1209,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -1623,6 +2027,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -2501,6 +3107,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -3498,6 +4306,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -4133,6 +5143,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -4749,6 +5961,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -5627,6 +7041,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -6255,6 +7871,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -6890,6 +8708,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -7506,6 +9526,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -8384,6 +10606,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -9682,6 +12106,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -10317,6 +12943,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -10933,6 +13761,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -11811,6 +14841,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -12490,6 +15722,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -13125,6 +16559,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -13741,6 +17377,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -14619,6 +18457,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -15553,6 +19593,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -16188,6 +20430,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -16804,6 +21248,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -17682,6 +22328,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -18602,6 +23450,208 @@
# defaultRouteAction has no effect when the URL map is bound
# to a target gRPC proxy that has the validateForProxyless field
# set to true.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -19237,6 +24287,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path matcher'sdefaultRouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -19853,6 +25105,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a path rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
@@ -20731,6 +26185,208 @@
#
# URL maps for classic Application Load Balancers only support
# the urlRewrite action within a route rule'srouteAction.
+ "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global
+ # EXTERNAL_MANAGED load balancer schemes.
+ "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name,
+ # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5
+ # header names can be specified. The cache is bypassed for all
+ # cachePolicy.cacheMode settings.
+ "A String",
+ ],
+ "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy.
+ # Policy defined on Route Action.
+ "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other
+ # parameters will be included. Either specify excluded_query_parameters or
+ # included_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "A String",
+ ],
+ "includeHost": True or False, # If true, requests to different hosts will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # host is never included in a Backend Bucket's cache key. Attempting to set
+ # it on a route that points exclusively to Backend Buckets will result in a
+ # configuration error.
+ "includeProtocol": True or False, # If true, http and https requests will be cached separately.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket, as the
+ # protocol is never included in a Backend Bucket's cache key. Attempting to
+ # set on a route that points exclusively to Backend Buckets will result in
+ # a configuration error.
+ "includeQueryString": True or False, # If true, include query string parameters in the cache key according to
+ # included_query_parameters and excluded_query_parameters. If neither is
+ # set, the entire query string will be included. If false, the query string
+ # will be excluded from the cache key entirely.
+ #
+ # Note: This field applies to routes that use backend services. Attempting
+ # to set it on a route that points exclusively to Backend Buckets will
+ # result in a configuration error. For routes that point to a Backend
+ # Bucket, use includedQueryParameters to define which parameters should
+ # be a part of the cache key.
+ "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key.
+ # The name=value pair will be used in the cache key Cloud CDN generates.
+ #
+ # Note: This setting is only applicable to routes that use a Backend
+ # Service. It does not affect requests served by a Backend Bucket.
+ # Attempting to set it on a route that points exclusively to Backend
+ # Buckets will result in a configuration error. Up to 5 cookie names can be
+ # specified.
+ "A String",
+ ],
+ "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key.
+ "A String",
+ ],
+ "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other
+ # parameters will be excluded. Either specify included_query_parameters or
+ # excluded_query_parameters, not both. '&' and '=' will be percent encoded
+ # and not treated as delimiters.
+ "A String",
+ ],
+ },
+ "cacheMode": "A String", # Specifies the cache setting for all responses from this route.
+ # If not specified, the default value is CACHE_ALL_STATIC.
+ "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is
+ # used to clamp the max-age (or Expires) value sent to the client. With
+ # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
+ # response max-age directive, along with a "public" directive. For
+ # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
+ # from the origin (if specified), or else sets the response max-age
+ # directive to the lesser of the client_ttl and default_ttl, and also
+ # ensures a "public" cache-control directive is present.
+ # If a client TTL is not specified, a default value (1 hour) will be used.
+ # The maximum allowed value is 31,622,400s (1 year).
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for
+ # responses that do not have an existing valid TTL (max-age or s-maxage).
+ # Setting a TTL of "0" means "always revalidate".
+ # The value of defaultTTL cannot be set to a value greater than that of
+ # maxTTL.
+ # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
+ # will overwrite the TTL set in all responses. The maximum allowed value is
+ # 31,622,400s (1 year). Infrequently accessed objects may be evicted from
+ # the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this
+ # origin.
+ # Cache directives that attempt to set a max-age or s-maxage higher than
+ # this, or an Expires header more than maxTTL seconds in the future will
+ # be capped at the value of maxTTL, as if it were the value of an
+ # s-maxage Cache-Control directive.
+ # Headers sent to the client will not be modified.
+ # Setting a TTL of "0" means "always revalidate".
+ # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order
+ # to apply fine-grained caching for common errors or redirects.
+ # This can reduce the load on your origin and improve end-user
+ # experience by reducing response latency.
+ # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
+ # negative caching applies to responses with the specified response code
+ # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
+ # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
+ # to all responses with the specified response code, and override any
+ # caching headers.
+ # By default, Cloud CDN will apply the following default TTLs to these
+ # status codes:
+ # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
+ # HTTP 404 (Not Found), 410 (Gone),
+ # 451 (Unavailable For Legal Reasons): 120s
+ # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
+ # These defaults can be overridden in negative_caching_policy.
+ "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code.
+ # negative_caching must be enabled to configure negative_caching_policy.
+ # Omitting the policy and leaving negative_caching enabled will use
+ # Cloud CDN's default cache TTLs.
+ # Note that when specifying an explicit negative_caching_policy, you
+ # should take care to specify a cache TTL for all response codes
+ # that you wish to cache. Cloud CDN will not apply any default
+ # negative caching when a policy exists.
+ { # Specify CDN TTLs for response error codes.
+ "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
+ # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
+ # specified as values, and you cannot specify a status code more than
+ # once.
+ "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the
+ # corresponding status code.
+ # The maximum allowed value is 1800s (30 minutes). Infrequently accessed
+ # objects may be evicted from the cache before the defined TTL.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
+ ],
+ "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
+ # requests into a small number of requests to the origin.
+ "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating
+ # content with the origin, or when an error is encountered when refreshing
+ # the cache.
+ # This setting defines the default "max-stale" duration for any cached
+ # responses that do not specify a max-stale directive. Stale responses that
+ # exceed the TTL configured here will not be served. The default limit
+ # (max-stale) is 86400s (1 day), which will allow stale content to be
+ # served up to this limit beyond the max-age (or s-maxage) of a cached
+ # response.
+ # The maximum allowed value is 604800 (1 week).
+ # Set this to zero (0) to disable serve-while-stale.
+ # as a count of seconds and fractions of seconds at nanosecond
+ # resolution. It is independent of any calendar and concepts like "day"
+ # or "month". Range is approximately 10,000 years.
+ "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
+ # Durations less than one second are represented with a 0
+ # `seconds` field and a positive `nanos` field. Must be from 0
+ # to 999,999,999 inclusive.
+ "seconds": "A String", # Span of time at a resolution of a second. Must be from 0
+ # to 315,576,000,000 inclusive. Note: these bounds are computed from:
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+ },
+ },
"corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more
# information about the W3C recommendation for cross-origin resource sharing
# (CORS), see Fetch API Living
diff --git a/docs/dyn/compute_v1.firewallPolicies.html b/docs/dyn/compute_v1.firewallPolicies.html
index e8a24db..b51a271 100644
--- a/docs/dyn/compute_v1.firewallPolicies.html
+++ b/docs/dyn/compute_v1.firewallPolicies.html
@@ -108,7 +108,7 @@
<code><a href="#list">list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the policies that have been configured for the specified</p>
<p class="toc_element">
- <code><a href="#listAssociations">listAssociations(targetResource=None, x__xgafv=None)</a></code></p>
+ <code><a href="#listAssociations">listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists associations of a specified target, i.e., organization or folder.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
@@ -3686,10 +3686,13 @@
</div>
<div class="method">
- <code class="details" id="listAssociations">listAssociations(targetResource=None, x__xgafv=None)</code>
+ <code class="details" id="listAssociations">listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)</code>
<pre>Lists associations of a specified target, i.e., organization or folder.
Args:
+ includeInheritedPolicies: boolean, If set to "true", the response will contain a list of all associations for
+the containing folders and the containing organization of the target. The
+parameter has no effect if the target is an organization.
targetResource: string, The target resource to list associations. It is an organization, or a
folder.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/compute_v1.futureReservations.html b/docs/dyn/compute_v1.futureReservations.html
index b672427..1bf5016 100644
--- a/docs/dyn/compute_v1.futureReservations.html
+++ b/docs/dyn/compute_v1.futureReservations.html
@@ -331,7 +331,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -411,7 +411,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1277,7 +1277,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1357,7 +1357,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1570,7 +1570,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1650,7 +1650,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2229,7 +2229,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2309,7 +2309,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2575,7 +2575,7 @@
"specificSkuProperties": { # Future Reservation configuration to indicate instance properties and
# total count.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2655,7 +2655,7 @@
"specificSkuProperties": { # Output only. [Output Only] The previous instance related properties of the
# Future Reservation.
"instanceProperties": { # Properties of the SKU instances being reserved. # Properties of the SKU instances being reserved.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
diff --git a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html
index 333c380..0c2b870 100644
--- a/docs/dyn/compute_v1.globalNetworkEndpointGroups.html
+++ b/docs/dyn/compute_v1.globalNetworkEndpointGroups.html
@@ -1062,6 +1062,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1205,6 +1219,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
body: object, The request body.
@@ -1215,6 +1243,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1731,6 +1773,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html
index a6a313b..ec8229d 100644
--- a/docs/dyn/compute_v1.instanceGroupManagers.html
+++ b/docs/dyn/compute_v1.instanceGroupManagers.html
@@ -750,6 +750,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
@@ -2870,6 +2881,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
@@ -3351,6 +3373,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
@@ -4186,6 +4219,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
@@ -5482,6 +5526,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html
index f739bd9..9c449a7 100644
--- a/docs/dyn/compute_v1.instanceTemplates.html
+++ b/docs/dyn/compute_v1.instanceTemplates.html
@@ -842,6 +842,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1109,6 +1111,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -2154,6 +2160,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2421,6 +2429,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -3469,6 +3481,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -3736,6 +3750,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -4776,6 +4794,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -5043,6 +5063,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index d8f7d58..c667b05 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -642,6 +642,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2145,6 +2147,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2558,6 +2562,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -4424,6 +4432,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -4691,6 +4701,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
# bulk.
@@ -6885,6 +6899,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -7298,6 +7314,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -9084,6 +9104,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -9497,6 +9519,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -10600,6 +10626,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -11013,6 +11041,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -19715,6 +19747,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -20128,6 +20162,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
"zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -21126,6 +21164,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
diff --git a/docs/dyn/compute_v1.instantSnapshots.html b/docs/dyn/compute_v1.instantSnapshots.html
index d17119a..ba416d2 100644
--- a/docs/dyn/compute_v1.instantSnapshots.html
+++ b/docs/dyn/compute_v1.instantSnapshots.html
@@ -259,6 +259,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -725,6 +737,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -1181,6 +1205,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -1632,6 +1668,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
diff --git a/docs/dyn/compute_v1.interconnects.html b/docs/dyn/compute_v1.interconnects.html
index 15d9190..d96e8a8 100644
--- a/docs/dyn/compute_v1.interconnects.html
+++ b/docs/dyn/compute_v1.interconnects.html
@@ -677,8 +677,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -1121,8 +1120,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -1774,8 +1772,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
@@ -2116,8 +2113,7 @@
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.
# No attachments may be provisioned or updated on this
# Interconnect.
- "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where
- # this connection is to be provisioned.
+ "subzone": "A String", # To be deprecated.
"wireGroups": [ # Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups
# configured to use this Interconnect. The Interconnect cannot be deleted if
# this list is non-empty.
diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html
index 9edd059..cc99212 100644
--- a/docs/dyn/compute_v1.machineImages.html
+++ b/docs/dyn/compute_v1.machineImages.html
@@ -1007,6 +1007,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1274,6 +1276,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -1706,6 +1712,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2926,6 +2934,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -3193,6 +3203,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -3625,6 +3639,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -4838,6 +4854,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -5105,6 +5123,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -5537,6 +5559,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
diff --git a/docs/dyn/compute_v1.networkEndpointGroups.html b/docs/dyn/compute_v1.networkEndpointGroups.html
index f3b5218..8747aa4 100644
--- a/docs/dyn/compute_v1.networkEndpointGroups.html
+++ b/docs/dyn/compute_v1.networkEndpointGroups.html
@@ -234,6 +234,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1420,6 +1434,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1563,6 +1591,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone where
@@ -1576,6 +1618,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -2094,6 +2150,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html
index cd2d720..1219ffb 100644
--- a/docs/dyn/compute_v1.regionCommitments.html
+++ b/docs/dyn/compute_v1.regionCommitments.html
@@ -340,6 +340,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -438,7 +441,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -783,6 +786,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -881,7 +887,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1136,6 +1142,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1234,7 +1243,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1852,6 +1861,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1950,7 +1962,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2256,6 +2268,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2354,7 +2369,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html
index 7f9d0e7..5f17131 100644
--- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html
@@ -2196,6 +2196,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
@@ -2674,6 +2685,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
@@ -3508,6 +3530,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
@@ -4796,6 +4829,17 @@
#
# - YES: If configuration updates are available, they are applied
# during repair.
+ "onFailedHealthCheck": "A String", # The action that a MIG performs on an unhealthy VM. A VM is marked as
+ # unhealthy when the application running on that VM fails a health check.
+ # Valid values are:
+ #
+ # - DEFAULT_ACTION (default): MIG uses the same action
+ # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
+ # - REPAIR: MIG automatically repairs an unhealthy VM by
+ # recreating it.
+ # - DO_NOTHING: MIG doesn't repair an unhealthy VM.
+ # For more information, see
+ # About repairing VMs in a MIG.
},
"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
# instance group. The group uses this template to create all new instances
diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html
index fcb43e7..1315446 100644
--- a/docs/dyn/compute_v1.regionInstanceTemplates.html
+++ b/docs/dyn/compute_v1.regionInstanceTemplates.html
@@ -1014,6 +1014,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1281,6 +1283,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -1959,6 +1965,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -2226,6 +2234,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
@@ -3267,6 +3279,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -3534,6 +3548,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only
# applicable for regional resources.
diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html
index 340e096..f117f86 100644
--- a/docs/dyn/compute_v1.regionInstances.html
+++ b/docs/dyn/compute_v1.regionInstances.html
@@ -1143,6 +1143,8 @@
# alias range. If not specified, the primary range of the subnetwork is used.
},
],
+ "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid
+ # with network_attachment.
"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface.
# This field will be ignored when inserting an Instance or
# adding a NetworkInterface. An up-to-date
@@ -1410,6 +1412,10 @@
"A String",
],
},
+ "workloadIdentityConfig": {
+ "identity": "A String",
+ "identityCertificateEnabled": True or False,
+ },
},
"locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
# bulk.
diff --git a/docs/dyn/compute_v1.regionInstantSnapshots.html b/docs/dyn/compute_v1.regionInstantSnapshots.html
index 0257993..9b1f2ed 100644
--- a/docs/dyn/compute_v1.regionInstantSnapshots.html
+++ b/docs/dyn/compute_v1.regionInstantSnapshots.html
@@ -448,6 +448,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -904,6 +916,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
@@ -1355,6 +1379,18 @@
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
+ "params": { # Additional instant snapshot params. # Input only. Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and
+ # values have the same definition as resource
+ # manager tags. Keys and values can be either in numeric format,
+ # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
+ # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
+ # `{tag_value_short_name}`. The field is ignored (both PUT &
+ # PATCH) when empty.
+ "a_key": "A String",
+ },
+ },
"region": "A String", # Output only. [Output Only] URL of the region where the instant snapshot resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
diff --git a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html
index 1c84742..8d4cfbd 100644
--- a/docs/dyn/compute_v1.regionNetworkEndpointGroups.html
+++ b/docs/dyn/compute_v1.regionNetworkEndpointGroups.html
@@ -1073,6 +1073,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1216,6 +1230,20 @@
<pre>Creates a network endpoint group in the specified project using the
parameters that are included in the request.
+Note: Use the following APIs to manage network endpoint groups:
+
+ -
+ To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ NEGs): zonal
+ API
+ -
+ To manage NEGs with regional scope (such as regional internet NEGs,
+ serverless NEGs, Private Service Connect NEGs): regional
+ API
+ -
+ To manage NEGs with global scope (such as global internet NEGs):global
+ API
+
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region where
@@ -1229,6 +1257,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
@@ -1747,6 +1789,20 @@
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located.
# For more information about using NEGs for different use cases, seeNetwork endpoint groups overview.
+ #
+ # Note: Use the following APIs to manage network endpoint groups:
+ #
+ # -
+ # To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
+ # NEGs): zonal
+ # API
+ # -
+ # To manage NEGs with regional scope (such as regional internet NEGs,
+ # serverless NEGs, Private Service Connect NEGs): regional
+ # API
+ # -
+ # To manage NEGs with global scope (such as global internet NEGs):global
+ # API
"annotations": { # Optional. Metadata defined as annotations on the network endpoint group.
"a_key": "A String",
},
diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html
index 961ed28..b374a41 100644
--- a/docs/dyn/compute_v1.reservations.html
+++ b/docs/dyn/compute_v1.reservations.html
@@ -287,6 +287,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -385,7 +388,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -880,6 +883,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -978,7 +984,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -1472,6 +1478,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -1570,7 +1579,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -2059,6 +2068,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -2157,7 +2169,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
@@ -3820,6 +3832,9 @@
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
+ "earlyAccessMaintenance": "A String", # Indicates the early access maintenance for the reservation.
+ # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
+ # enrolled in early access maintenance and the standard notice applies.
"enableEmergentMaintenance": True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
# for example, to fix hardware errors.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
@@ -3918,7 +3933,7 @@
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # Output only. [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
- # Next ID: 9
+ # Next ID: 10
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the
# instance.
diff --git a/docs/dyn/connectors_v2.projects.locations.connections.html b/docs/dyn/connectors_v2.projects.locations.connections.html
index 0469660..c8beb21 100644
--- a/docs/dyn/connectors_v2.projects.locations.connections.html
+++ b/docs/dyn/connectors_v2.projects.locations.connections.html
@@ -110,6 +110,12 @@
<code><a href="#executeSqlQuery">executeSqlQuery(connection, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.</p>
<p class="toc_element">
+ <code><a href="#generateConnectionToolspecOverride">generateConnectionToolspecOverride(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Generate toolspec override for the given list of toolNames.</p>
+<p class="toc_element">
+ <code><a href="#listCustomToolNames">listCustomToolNames(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists custom tool names.</p>
+<p class="toc_element">
<code><a href="#refreshAccessToken">refreshAccessToken(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).</p>
<p class="toc_element">
@@ -257,6 +263,70 @@
</div>
<div class="method">
+ <code class="details" id="generateConnectionToolspecOverride">generateConnectionToolspecOverride(name, body=None, x__xgafv=None)</code>
+ <pre>Generate toolspec override for the given list of toolNames.
+
+Args:
+ name: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "toolNames": [ # list of tools to be generated.
+ {
+ "entityName": "A String", # Entity name for which the tool was generated.
+ "name": "A String", # Tool name that was generated in the list tools call.
+ "operation": "A String", # Operation for which the tool was generated.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "toolSpec": { # tool spec that has tool_defitions array containing the tools for all sted tool_names.
+ "toolDefinitions": [ # List of tool definitions.
+ {
+ "a_key": "", # Properties of the object.
+ },
+ ],
+ "toolSpecVersion": "A String", # Version of the tool spec. Format: providerId/connectorId/versionId/toolSpecId
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listCustomToolNames">listCustomToolNames(name, x__xgafv=None)</code>
+ <pre>Lists custom tool names.
+
+Args:
+ name: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "toolNames": [ # List of custom tools.
+ {
+ "entityName": "A String", # Entity name for which the tool was generated.
+ "name": "A String", # Tool name that was generated in the list tools call.
+ "operation": "A String", # Operation for which the tool was generated.
+ },
+ ],
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="refreshAccessToken">refreshAccessToken(name, body=None, x__xgafv=None)</code>
<pre>RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).
diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html
index c2c0bde..ffc244d 100644
--- a/docs/dyn/container_v1.projects.locations.clusters.html
+++ b/docs/dyn/container_v1.projects.locations.clusters.html
@@ -418,7 +418,7 @@
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -588,6 +588,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -820,6 +826,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -855,6 +864,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1029,6 +1040,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1064,6 +1078,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1151,6 +1167,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1186,6 +1205,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1338,6 +1359,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1373,6 +1397,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1550,7 +1576,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1659,7 +1685,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -2036,7 +2062,7 @@
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -2206,6 +2232,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -2438,6 +2470,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2473,6 +2508,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2647,6 +2684,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2682,6 +2722,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2769,6 +2811,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2804,6 +2849,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2956,6 +3003,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2991,6 +3041,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3168,7 +3220,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -3277,7 +3329,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -3518,7 +3570,7 @@
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -3688,6 +3740,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -3920,6 +3978,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -3955,6 +4016,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4129,6 +4192,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4164,6 +4230,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4251,6 +4319,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4286,6 +4357,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4438,6 +4511,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4473,6 +4549,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4650,7 +4728,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -4759,7 +4837,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -5190,6 +5268,12 @@
{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
"clusterId": "A String", # Required. The name of the cluster to update.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -5864,7 +5948,7 @@
},
],
},
- "desiredCompliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "desiredCompliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -6083,6 +6167,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6118,6 +6205,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -6133,6 +6222,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6168,6 +6260,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html
index 95d5369..e50ee1c 100644
--- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html
+++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html
@@ -294,6 +294,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -329,6 +332,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -506,7 +511,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -891,6 +896,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -926,6 +934,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1103,7 +1113,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1315,6 +1325,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1350,6 +1363,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1527,7 +1542,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -2025,6 +2040,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2060,6 +2078,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2148,7 +2168,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html
index d057a64..6487ad8 100644
--- a/docs/dyn/container_v1.projects.zones.clusters.html
+++ b/docs/dyn/container_v1.projects.zones.clusters.html
@@ -519,7 +519,7 @@
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -689,6 +689,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -921,6 +927,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -956,6 +965,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1130,6 +1141,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1165,6 +1179,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1252,6 +1268,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1287,6 +1306,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1439,6 +1460,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1474,6 +1498,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1651,7 +1677,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1760,7 +1786,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -2137,7 +2163,7 @@
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -2307,6 +2333,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -2539,6 +2571,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2574,6 +2609,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2748,6 +2785,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2783,6 +2823,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2870,6 +2912,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2905,6 +2950,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3057,6 +3104,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -3092,6 +3142,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3269,7 +3321,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -3378,7 +3430,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -3663,7 +3715,7 @@
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -3833,6 +3885,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -4065,6 +4123,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4100,6 +4161,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4274,6 +4337,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4309,6 +4375,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4396,6 +4464,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4431,6 +4502,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4583,6 +4656,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4618,6 +4694,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4795,7 +4873,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -4904,7 +4982,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -5368,6 +5446,12 @@
{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
"clusterId": "A String", # Required. The name of the cluster to update.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -5891,7 +5975,7 @@
},
],
},
- "desiredCompliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "desiredCompliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -6110,6 +6194,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6145,6 +6232,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -6160,6 +6249,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6195,6 +6287,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
index 8591d60..21488af 100644
--- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
+++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
@@ -359,6 +359,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -394,6 +397,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -571,7 +576,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -956,6 +961,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -991,6 +999,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1168,7 +1178,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1380,6 +1390,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1415,6 +1428,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1592,7 +1607,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -2015,6 +2030,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2050,6 +2068,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2138,7 +2158,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html
index 76e134d..df67010 100644
--- a/docs/dyn/container_v1beta1.projects.locations.clusters.html
+++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html
@@ -516,7 +516,7 @@
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -688,6 +688,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -939,6 +945,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -974,6 +983,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1150,6 +1161,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1185,6 +1199,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1280,6 +1296,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1315,6 +1334,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1479,6 +1500,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1514,6 +1538,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1695,7 +1721,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1824,7 +1850,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -2242,7 +2268,7 @@
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -2414,6 +2440,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -2665,6 +2697,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2700,6 +2735,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2876,6 +2913,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2911,6 +2951,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3006,6 +3048,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -3041,6 +3086,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3205,6 +3252,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -3240,6 +3290,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3421,7 +3473,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -3550,7 +3602,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -3825,7 +3877,7 @@
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -3997,6 +4049,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -4248,6 +4306,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4283,6 +4344,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4459,6 +4522,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4494,6 +4560,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4589,6 +4657,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4624,6 +4695,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4788,6 +4861,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4823,6 +4899,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -5004,7 +5082,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -5133,7 +5211,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -5587,6 +5665,12 @@
{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
"clusterId": "A String", # Required. The name of the cluster to update.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -6279,7 +6363,7 @@
"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "desiredCompliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "desiredCompliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -6512,6 +6596,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6547,6 +6634,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -6562,6 +6651,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6597,6 +6689,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html
index 6ee2636..02db90d 100644
--- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html
+++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html
@@ -306,6 +306,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -341,6 +344,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -522,7 +527,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -921,6 +926,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -956,6 +964,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1137,7 +1147,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1361,6 +1371,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1396,6 +1409,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1577,7 +1592,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -2076,6 +2091,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2111,6 +2129,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2201,7 +2221,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html
index bd3e1b8..d1c2d90 100644
--- a/docs/dyn/container_v1beta1.projects.zones.clusters.html
+++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html
@@ -627,7 +627,7 @@
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -799,6 +799,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -1050,6 +1056,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1085,6 +1094,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1261,6 +1272,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1296,6 +1310,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1391,6 +1407,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1426,6 +1445,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1590,6 +1611,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1625,6 +1649,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1806,7 +1832,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1935,7 +1961,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -2353,7 +2379,7 @@
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -2525,6 +2551,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -2776,6 +2808,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2811,6 +2846,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2987,6 +3024,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -3022,6 +3062,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3117,6 +3159,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -3152,6 +3197,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3316,6 +3363,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -3351,6 +3401,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -3532,7 +3584,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -3661,7 +3713,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -3980,7 +4032,7 @@
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "compliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -4152,6 +4204,12 @@
},
"loggingService": "A String", # The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -4403,6 +4461,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4438,6 +4499,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4614,6 +4677,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4649,6 +4715,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4744,6 +4812,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4779,6 +4850,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -4943,6 +5016,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -4978,6 +5054,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -5159,7 +5237,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -5288,7 +5366,7 @@
"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
},
},
- "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
+ "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
@@ -5765,6 +5843,12 @@
{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
"clusterId": "A String", # Required. The name of the cluster to update.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
+ "disruptionBudget": { # DisruptionBudget defines the upgrade disruption budget for the cluster control plane. # Optional. The upgrade disruption budget for the cluster control plane.
+ "lastDisruptionTime": "A String", # Output only. The last time a disruption was performed on the control plane.
+ "lastMinorVersionDisruptionTime": "A String", # Output only. The last time a minor version upgrade was performed on the control plane.
+ "minorVersionDisruptionInterval": "A String", # Optional. The minimum duration between two minor version upgrades of the control plane.
+ "patchVersionDisruptionInterval": "A String", # Optional. The minimum duration between two patch version upgrades of the control plane.
+ },
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
@@ -6306,7 +6390,7 @@
"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
- "desiredCompliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
+ "desiredCompliancePostureConfig": { # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
@@ -6539,6 +6623,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6574,6 +6661,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -6589,6 +6678,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -6624,6 +6716,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
index c9d29db..2d07ee3 100644
--- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
+++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
@@ -371,6 +371,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -406,6 +409,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -587,7 +592,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -986,6 +991,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1021,6 +1029,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1202,7 +1212,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -1426,6 +1436,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -1461,6 +1474,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -1642,7 +1657,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
@@ -2066,6 +2081,9 @@
"cpuCfsQuota": True or False, # Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
"cpuCfsQuotaPeriod": "A String", # Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
"cpuManagerPolicy": "A String", # Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
+ "crashLoopBackOff": { # Contains config to modify node-level parameters for container restart behavior. # Optional. Contains configuration options to modify node-level parameters for container restart behavior.
+ "maxContainerRestartPeriod": "A String", # Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.
+ },
"evictionMaxPodGracePeriodSeconds": 42, # Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
"evictionMinimumReclaim": { # Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. # Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
"imagefsAvailable": "A String", # Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
@@ -2101,6 +2119,8 @@
"policy": "A String", # Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.
},
"podPidsLimit": "A String", # Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
+ "shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].
+ "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.
"singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
"topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
"policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).
@@ -2191,7 +2211,7 @@
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
"podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
+ "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
diff --git a/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html b/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html
index 3aa880a..724ee9e 100644
--- a/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html
+++ b/docs/dyn/datacatalog_v1.projects.locations.tagTemplates.html
@@ -118,7 +118,7 @@
body: object, The request body.
The object takes the form of:
-{ # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
+{ # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Optional. Transfer status of the TagTemplate
"displayName": "A String", # Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
@@ -153,7 +153,7 @@
Returns:
An object of the form:
- { # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
+ { # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Optional. Transfer status of the TagTemplate
"displayName": "A String", # Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
@@ -213,7 +213,7 @@
Returns:
An object of the form:
- { # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
+ { # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Optional. Transfer status of the TagTemplate
"displayName": "A String", # Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
@@ -292,7 +292,7 @@
body: object, The request body.
The object takes the form of:
-{ # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
+{ # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Optional. Transfer status of the TagTemplate
"displayName": "A String", # Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
@@ -327,7 +327,7 @@
Returns:
An object of the form:
- { # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
+ { # A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Optional. Transfer status of the TagTemplate
"displayName": "A String", # Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore.
diff --git a/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html b/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html
index 3fc5822..95fb8c1 100644
--- a/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html
+++ b/docs/dyn/datacatalog_v1beta1.projects.locations.tagTemplates.html
@@ -118,7 +118,7 @@
body: object, The request body.
The object takes the form of:
-{ # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
+{ # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Output only. Transfer status of the TagTemplate
"displayName": "A String", # The display name for this template. Defaults to an empty string.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
@@ -152,7 +152,7 @@
Returns:
An object of the form:
- { # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
+ { # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Output only. Transfer status of the TagTemplate
"displayName": "A String", # The display name for this template. Defaults to an empty string.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
@@ -211,7 +211,7 @@
Returns:
An object of the form:
- { # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
+ { # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Output only. Transfer status of the TagTemplate
"displayName": "A String", # The display name for this template. Defaults to an empty string.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
@@ -289,7 +289,7 @@
body: object, The request body.
The object takes the form of:
-{ # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
+{ # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Output only. Transfer status of the TagTemplate
"displayName": "A String", # The display name for this template. Defaults to an empty string.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
@@ -323,7 +323,7 @@
Returns:
An object of the form:
- { # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
+ { # A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
"dataplexTransferStatus": "A String", # Output only. Transfer status of the TagTemplate
"displayName": "A String", # The display name for this template. Defaults to an empty string.
"fields": { # Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html
index 8089c48..53c9a79 100644
--- a/docs/dyn/dataflow_v1b3.projects.jobs.html
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.html
@@ -356,6 +356,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -449,7 +450,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -719,6 +721,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -812,7 +815,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -1066,6 +1070,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -1159,7 +1164,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -1420,6 +1426,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -1513,7 +1520,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -1834,6 +1842,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -1927,7 +1936,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -2238,6 +2248,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -2331,7 +2342,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -2579,6 +2591,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -2672,7 +2685,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html
index ebc1c33..9aaa627 100644
--- a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html
+++ b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html
@@ -438,6 +438,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -531,7 +532,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html
index 490d7bb..0a28f0f 100644
--- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html
+++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html
@@ -344,6 +344,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -437,7 +438,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -690,6 +692,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -783,7 +786,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -1044,6 +1048,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -1137,7 +1142,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -1568,6 +1574,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -1661,7 +1668,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -1974,6 +1982,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -2067,7 +2076,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -2314,6 +2324,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -2407,7 +2418,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html
index 23dc6ec..78160f9 100644
--- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html
+++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html
@@ -345,6 +345,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -438,7 +439,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -844,6 +846,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -937,7 +940,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html
index d088b2b..0d077f9 100644
--- a/docs/dyn/dataflow_v1b3.projects.templates.html
+++ b/docs/dyn/dataflow_v1b3.projects.templates.html
@@ -344,6 +344,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -437,7 +438,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
@@ -843,6 +845,7 @@
},
"location": "A String", # Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
"name": "A String", # Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
+ "pausable": True or False, # Output only. Indicates whether the job can be paused.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -936,7 +939,8 @@
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
- "acceptableBacklogDuration": "A String", # Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.
+ "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency".
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline).
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
index 3877584..1c65b1b 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
@@ -346,7 +346,7 @@
"rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -423,7 +423,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -588,7 +588,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -867,7 +867,7 @@
"rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -944,7 +944,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -1302,7 +1302,7 @@
"rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -1379,7 +1379,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -1698,7 +1698,7 @@
"rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -1775,7 +1775,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -2112,7 +2112,7 @@
"rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -2189,7 +2189,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
index a7d33a5..1838f75 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
@@ -120,7 +120,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -395,7 +395,7 @@
"rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -472,7 +472,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -756,7 +756,7 @@
"rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
@@ -833,7 +833,7 @@
{ # A rule captures data quality intent about a data source.
"column": "A String", # Optional. The unnested column which this rule is evaluated against.
"description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
- "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
+ "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.
"ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
"name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
"nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
index 6e07d14..9e5ff24 100644
--- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
+++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
@@ -85,10 +85,10 @@
<p class="firstline">Deletes an Entry.</p>
<p class="toc_element">
<code><a href="#get">get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).</p>
+<p class="firstline">Gets an Entry.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).</p>
+<p class="firstline">Lists Entries within an EntryGroup.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -269,7 +269,7 @@
<div class="method">
<code class="details" id="get">get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)</code>
- <pre>Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).
+ <pre>Gets an Entry.
Args:
name: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required)
@@ -337,7 +337,7 @@
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).
+ <pre>Lists Entries within an EntryGroup.
Args:
parent: string, Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. (required)
diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html
index cba7bf8..1223009 100644
--- a/docs/dyn/dataplex_v1.projects.locations.html
+++ b/docs/dyn/dataplex_v1.projects.locations.html
@@ -150,6 +150,11 @@
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
+ <code><a href="dataplex_v1.projects.locations.policyIntents.html">policyIntents()</a></code>
+</p>
+<p class="firstline">Returns the policyIntents Resource.</p>
+
+<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
@@ -163,7 +168,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#lookupEntry">lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).</p>
+<p class="firstline">Looks up an entry by name using the permission on the source system.</p>
<p class="toc_element">
<code><a href="#searchEntries">searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, semanticSearch=None, x__xgafv=None)</a></code></p>
<p class="firstline">Searches for Entries matching the given query and scope.</p>
@@ -255,7 +260,7 @@
<div class="method">
<code class="details" id="lookupEntry">lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)</code>
- <pre>Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).
+ <pre>Looks up an entry by name using the permission on the source system.
Args:
name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required)
diff --git a/docs/dyn/dataplex_v1.projects.locations.policyIntents.html b/docs/dyn/dataplex_v1.projects.locations.policyIntents.html
new file mode 100644
index 0000000..6b175cd
--- /dev/null
+++ b/docs/dyn/dataplex_v1.projects.locations.policyIntents.html
@@ -0,0 +1,258 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="dataplex_v1.html">Cloud Dataplex API</a> . <a href="dataplex_v1.projects.html">projects</a> . <a href="dataplex_v1.projects.locations.html">locations</a> . <a href="dataplex_v1.projects.locations.policyIntents.html">policyIntents</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
+ <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:[email protected], and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, [email protected] . serviceAccount:{emailid}: An email address that represents a Google service account. For example, [email protected]. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, [email protected]. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:[email protected], and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, [email protected] . serviceAccount:{emailid}: An email address that represents a Google service account. For example, [email protected]. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, [email protected]. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:[email protected], and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, [email protected] . serviceAccount:{emailid}: An email address that represents a Google service account. For example, [email protected]. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, [email protected]. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
+ <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+ "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for TestIamPermissions method.
+ "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+ "A String",
+ ],
+}</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.html b/docs/dyn/dataproc_v1.projects.locations.batches.html
index affac1d..875e267 100644
--- a/docs/dyn/dataproc_v1.projects.locations.batches.html
+++ b/docs/dyn/dataproc_v1.projects.locations.batches.html
@@ -308,7 +308,7 @@
}
batchId: string, Optional. The ID to use for the batch, which will become the final component of the batch's resource name.This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.
- requestId: string, Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
+ requestId: string, Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the operation that corresponds to the first Batch created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/dfareporting_v4.conversions.html b/docs/dyn/dfareporting_v4.conversions.html
index 3a18b40..68b087f 100644
--- a/docs/dyn/dfareporting_v4.conversions.html
+++ b/docs/dyn/dfareporting_v4.conversions.html
@@ -97,7 +97,7 @@
"conversions": [ # The set of conversions to insert.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -178,7 +178,7 @@
{ # The original conversion that was inserted or updated and whether there were any errors.
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -260,7 +260,7 @@
"conversions": [ # The set of conversions to update.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -341,7 +341,7 @@
{ # The original conversion that was inserted or updated and whether there were any errors.
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
diff --git a/docs/dyn/dfareporting_v4.dynamicFeeds.html b/docs/dyn/dfareporting_v4.dynamicFeeds.html
index 821e96e..d694bf5 100644
--- a/docs/dyn/dfareporting_v4.dynamicFeeds.html
+++ b/docs/dyn/dfareporting_v4.dynamicFeeds.html
@@ -85,10 +85,10 @@
<p class="firstline">Inserts a new dynamic feed.</p>
<p class="toc_element">
<code><a href="#retransform">retransform(dynamicFeedId, x__xgafv=None)</a></code></p>
-<p class="firstline">Retransforms a dynamic feed.</p>
+<p class="firstline">Retransforms a dynamic feed. Only draft feeds can be retransformed (i.e. the feed has not been published).</p>
<p class="toc_element">
<code><a href="#update">update(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a new dynamic feed.</p>
+<p class="firstline">Updates a new dynamic feed. For draft feeds, only Element can be updated. For published feeds, only FeedSchedule can be updated. Other fields will be ignored.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -109,7 +109,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -212,8 +212,8 @@
body: object, The request body.
The object takes the form of:
-{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See
- "dynamicFeed": { # Contains dynamic feed information. # Required. Dynamic feed to insert.
+{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynamic feed itself don't need the dynamic profile id.
+ "dynamicFeed": { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information. # Required. Dynamic feed to insert.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -317,7 +317,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -414,7 +414,7 @@
<div class="method">
<code class="details" id="retransform">retransform(dynamicFeedId, x__xgafv=None)</code>
- <pre>Retransforms a dynamic feed.
+ <pre>Retransforms a dynamic feed. Only draft feeds can be retransformed (i.e. the feed has not been published).
Args:
dynamicFeedId: string, Required. Dynamic feed ID. (required)
@@ -426,7 +426,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -523,13 +523,13 @@
<div class="method">
<code class="details" id="update">update(body=None, x__xgafv=None)</code>
- <pre>Updates a new dynamic feed.
+ <pre>Updates a new dynamic feed. For draft feeds, only Element can be updated. For published feeds, only FeedSchedule can be updated. Other fields will be ignored.
Args:
body: object, The request body.
The object takes the form of:
-{ # Contains dynamic feed information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -631,7 +631,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
diff --git a/docs/dyn/dfareporting_v4.dynamicProfiles.html b/docs/dyn/dfareporting_v4.dynamicProfiles.html
index a2cc237..69a1f35 100644
--- a/docs/dyn/dfareporting_v4.dynamicProfiles.html
+++ b/docs/dyn/dfareporting_v4.dynamicProfiles.html
@@ -79,7 +79,7 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#generateCode">generateCode(dynamicProfileId, x__xgafv=None)</a></code></p>
-<p class="firstline">Generates code for a dynamic profile.</p>
+<p class="firstline">Generates code for a dynamic profile, which will need unescaping.</p>
<p class="toc_element">
<code><a href="#get">get(dynamicProfileId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a dynamic profile by ID.</p>
@@ -100,7 +100,7 @@
<div class="method">
<code class="details" id="generateCode">generateCode(dynamicProfileId, x__xgafv=None)</code>
- <pre>Generates code for a dynamic profile.
+ <pre>Generates code for a dynamic profile, which will need unescaping.
Args:
dynamicProfileId: string, Required. Dynamic profile ID. (required)
@@ -113,7 +113,7 @@
An object of the form:
{ # Response message for DfareportingDynamicProfiles.GenerateCode.
- "code": "A String", # Generated code for the dynamic profile.
+ "code": "A String", # Generated code for the dynamic profile. The code will need to be unescaped.
}</pre>
</div>
@@ -131,7 +131,7 @@
Returns:
An object of the form:
- { # Contains dynamic profile information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -294,7 +294,7 @@
body: object, The request body.
The object takes the form of:
-{ # Contains dynamic profile information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -456,7 +456,7 @@
Returns:
An object of the form:
- { # Contains dynamic profile information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -632,7 +632,7 @@
body: object, The request body.
The object takes the form of:
-{ # Contains dynamic profile information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -794,7 +794,7 @@
Returns:
An object of the form:
- { # Contains dynamic profile information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
diff --git a/docs/dyn/dfareporting_v4.studioCreativeAssets.html b/docs/dyn/dfareporting_v4.studioCreativeAssets.html
index da16198..02bcbc4 100644
--- a/docs/dyn/dfareporting_v4.studioCreativeAssets.html
+++ b/docs/dyn/dfareporting_v4.studioCreativeAssets.html
@@ -112,7 +112,7 @@
{ # Response message for DfareportingStudioCreativeAssets.Insert.
"assets": [ # The list of studio creative assets.
- { # Contains studio creative asset information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative asset information.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the studio creative asset. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
diff --git a/docs/dyn/dfareporting_v4.studioCreatives.html b/docs/dyn/dfareporting_v4.studioCreatives.html
index 477b09b..e05a949 100644
--- a/docs/dyn/dfareporting_v4.studioCreatives.html
+++ b/docs/dyn/dfareporting_v4.studioCreatives.html
@@ -106,11 +106,11 @@
Returns:
An object of the form:
- { # Contains studio creative information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.
"assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
"A String",
],
- "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+ "backupImageAssetId": "A String", # Backup image asset ID of this studio creative. It is a required field on insertion.
"createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
@@ -140,11 +140,11 @@
body: object, The request body.
The object takes the form of:
-{ # Contains studio creative information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.
"assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
"A String",
],
- "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+ "backupImageAssetId": "A String", # Backup image asset ID of this studio creative. It is a required field on insertion.
"createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
@@ -173,11 +173,11 @@
Returns:
An object of the form:
- { # Contains studio creative information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.
"assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
"A String",
],
- "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+ "backupImageAssetId": "A String", # Backup image asset ID of this studio creative. It is a required field on insertion.
"createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
diff --git a/docs/dyn/dfareporting_v5.ads.html b/docs/dyn/dfareporting_v5.ads.html
index 3ab8e7e..2e99450 100644
--- a/docs/dyn/dfareporting_v5.ads.html
+++ b/docs/dyn/dfareporting_v5.ads.html
@@ -278,6 +278,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -604,6 +607,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -928,6 +934,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -1303,6 +1312,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -1648,6 +1660,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -1972,6 +1987,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -2298,6 +2316,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -2622,6 +2643,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
diff --git a/docs/dyn/dfareporting_v5.conversions.html b/docs/dyn/dfareporting_v5.conversions.html
index 7ffcf71..43e94aa 100644
--- a/docs/dyn/dfareporting_v5.conversions.html
+++ b/docs/dyn/dfareporting_v5.conversions.html
@@ -97,7 +97,7 @@
"conversions": [ # The set of conversions to insert.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -178,7 +178,7 @@
{ # The original conversion that was inserted or updated and whether there were any errors.
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -260,7 +260,7 @@
"conversions": [ # The set of conversions to update.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
@@ -341,7 +341,7 @@
{ # The original conversion that was inserted or updated and whether there were any errors.
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
"adUserDataConsent": "A String", # This represents consent for ad user data.
- "cartData": { # *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
+ "cartData": { # Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788) # The cart data associated with this conversion.
"items": [ # Data of the items purchased.
{ # Contains data of the items purchased.
"itemId": "A String", # The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.
diff --git a/docs/dyn/dfareporting_v5.countries.html b/docs/dyn/dfareporting_v5.countries.html
index d0d35ce..989a95c 100644
--- a/docs/dyn/dfareporting_v5.countries.html
+++ b/docs/dyn/dfareporting_v5.countries.html
@@ -110,6 +110,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
}</pre>
</div>
@@ -135,6 +138,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
diff --git a/docs/dyn/dfareporting_v5.dynamicFeeds.html b/docs/dyn/dfareporting_v5.dynamicFeeds.html
index dbb88e9..8955384 100644
--- a/docs/dyn/dfareporting_v5.dynamicFeeds.html
+++ b/docs/dyn/dfareporting_v5.dynamicFeeds.html
@@ -85,10 +85,10 @@
<p class="firstline">Inserts a new dynamic feed.</p>
<p class="toc_element">
<code><a href="#retransform">retransform(dynamicFeedId, x__xgafv=None)</a></code></p>
-<p class="firstline">Retransforms a dynamic feed.</p>
+<p class="firstline">Retransforms a dynamic feed. Only draft feeds can be retransformed (i.e. the feed has not been published).</p>
<p class="toc_element">
<code><a href="#update">update(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a new dynamic feed.</p>
+<p class="firstline">Updates a new dynamic feed. For draft feeds, only Element can be updated. For published feeds, only FeedSchedule can be updated. Other fields will be ignored.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -109,7 +109,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -212,8 +212,8 @@
body: object, The request body.
The object takes the form of:
-{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See
- "dynamicFeed": { # Contains dynamic feed information. # Required. Dynamic feed to insert.
+{ # Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynamic feed itself don't need the dynamic profile id.
+ "dynamicFeed": { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information. # Required. Dynamic feed to insert.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -317,7 +317,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -414,7 +414,7 @@
<div class="method">
<code class="details" id="retransform">retransform(dynamicFeedId, x__xgafv=None)</code>
- <pre>Retransforms a dynamic feed.
+ <pre>Retransforms a dynamic feed. Only draft feeds can be retransformed (i.e. the feed has not been published).
Args:
dynamicFeedId: string, Required. Dynamic feed ID. (required)
@@ -426,7 +426,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -523,13 +523,13 @@
<div class="method">
<code class="details" id="update">update(body=None, x__xgafv=None)</code>
- <pre>Updates a new dynamic feed.
+ <pre>Updates a new dynamic feed. For draft feeds, only Element can be updated. For published feeds, only FeedSchedule can be updated. Other fields will be ignored.
Args:
body: object, The request body.
The object takes the form of:
-{ # Contains dynamic feed information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
@@ -631,7 +631,7 @@
Returns:
An object of the form:
- { # Contains dynamic feed information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.
"contentSource": { # Contains the content source of the dynamic feed. # Required. The content source of the dynamic feed. This is a required field.
"contentSourceName": "A String", # Optional. The name of the content source. It is defaulted to content source file name if not provided.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the content source. This is a read-only field.
diff --git a/docs/dyn/dfareporting_v5.dynamicProfiles.html b/docs/dyn/dfareporting_v5.dynamicProfiles.html
index bd3296c..cae97db 100644
--- a/docs/dyn/dfareporting_v5.dynamicProfiles.html
+++ b/docs/dyn/dfareporting_v5.dynamicProfiles.html
@@ -79,7 +79,7 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#generateCode">generateCode(dynamicProfileId, x__xgafv=None)</a></code></p>
-<p class="firstline">Generates code for a dynamic profile.</p>
+<p class="firstline">Generates code for a dynamic profile, which will need unescaping.</p>
<p class="toc_element">
<code><a href="#get">get(dynamicProfileId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a dynamic profile by ID.</p>
@@ -100,7 +100,7 @@
<div class="method">
<code class="details" id="generateCode">generateCode(dynamicProfileId, x__xgafv=None)</code>
- <pre>Generates code for a dynamic profile.
+ <pre>Generates code for a dynamic profile, which will need unescaping.
Args:
dynamicProfileId: string, Required. Dynamic profile ID. (required)
@@ -113,7 +113,7 @@
An object of the form:
{ # Response message for DfareportingDynamicProfiles.GenerateCode.
- "code": "A String", # Generated code for the dynamic profile.
+ "code": "A String", # Generated code for the dynamic profile. The code will need to be unescaped.
}</pre>
</div>
@@ -131,7 +131,7 @@
Returns:
An object of the form:
- { # Contains dynamic profile information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -294,7 +294,7 @@
body: object, The request body.
The object takes the form of:
-{ # Contains dynamic profile information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -456,7 +456,7 @@
Returns:
An object of the form:
- { # Contains dynamic profile information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -632,7 +632,7 @@
body: object, The request body.
The object takes the form of:
-{ # Contains dynamic profile information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
@@ -794,7 +794,7 @@
Returns:
An object of the form:
- { # Contains dynamic profile information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
diff --git a/docs/dyn/dfareporting_v5.studioCreativeAssets.html b/docs/dyn/dfareporting_v5.studioCreativeAssets.html
index 9fc0e73..7ecf143 100644
--- a/docs/dyn/dfareporting_v5.studioCreativeAssets.html
+++ b/docs/dyn/dfareporting_v5.studioCreativeAssets.html
@@ -112,7 +112,7 @@
{ # Response message for DfareportingStudioCreativeAssets.Insert.
"assets": [ # The list of studio creative assets.
- { # Contains studio creative asset information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative asset information.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the studio creative asset. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
diff --git a/docs/dyn/dfareporting_v5.studioCreatives.html b/docs/dyn/dfareporting_v5.studioCreatives.html
index 2aaef1d..3c913e7 100644
--- a/docs/dyn/dfareporting_v5.studioCreatives.html
+++ b/docs/dyn/dfareporting_v5.studioCreatives.html
@@ -106,11 +106,11 @@
Returns:
An object of the form:
- { # Contains studio creative information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.
"assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
"A String",
],
- "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+ "backupImageAssetId": "A String", # Backup image asset ID of this studio creative. It is a required field on insertion.
"createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
@@ -140,11 +140,11 @@
body: object, The request body.
The object takes the form of:
-{ # Contains studio creative information.
+{ # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.
"assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
"A String",
],
- "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+ "backupImageAssetId": "A String", # Backup image asset ID of this studio creative. It is a required field on insertion.
"createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
@@ -173,11 +173,11 @@
Returns:
An object of the form:
- { # Contains studio creative information.
+ { # *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.
"assetIds": [ # List of assets associated with this studio creative. It is a required field on insertion.
"A String",
],
- "backupImageAssetId": "A String", # Backup image asset ID of this studio creative.
+ "backupImageAssetId": "A String", # Backup image asset ID of this studio creative. It is a required field on insertion.
"createdInfo": { # Modification timestamp. # The timestamp when the studio creative was created. This is a read-only, auto-generated field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
diff --git a/docs/dyn/dfareporting_v5.targetingTemplates.html b/docs/dyn/dfareporting_v5.targetingTemplates.html
index 84442bd..a3ed591 100644
--- a/docs/dyn/dfareporting_v5.targetingTemplates.html
+++ b/docs/dyn/dfareporting_v5.targetingTemplates.html
@@ -164,6 +164,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -338,6 +341,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -510,6 +516,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -706,6 +715,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -897,6 +909,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -1069,6 +1084,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -1243,6 +1261,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
@@ -1415,6 +1436,9 @@
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
"name": "A String", # Name of this country.
"sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ "tvDataProviders": [ # Output only. The TV data providers supported in this country.
+ "A String",
+ ],
},
],
"excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
diff --git a/docs/dyn/dfareporting_v5.tvCampaignDetails.html b/docs/dyn/dfareporting_v5.tvCampaignDetails.html
index a0d1231..4f1914f 100644
--- a/docs/dyn/dfareporting_v5.tvCampaignDetails.html
+++ b/docs/dyn/dfareporting_v5.tvCampaignDetails.html
@@ -78,7 +78,7 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#get">get(profileId, id, accountId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(profileId, id, accountId=None, countryDartId=None, tvDataProvider=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one TvCampaignDetail by ID.</p>
<h3>Method Details</h3>
<div class="method">
@@ -87,13 +87,25 @@
</div>
<div class="method">
- <code class="details" id="get">get(profileId, id, accountId=None, x__xgafv=None)</code>
+ <code class="details" id="get">get(profileId, id, accountId=None, countryDartId=None, tvDataProvider=None, x__xgafv=None)</code>
<pre>Gets one TvCampaignDetail by ID.
Args:
profileId: string, Required. User profile ID associated with this request. (required)
id: string, Required. TV Campaign ID. (required)
accountId: string, Required. Account ID associated with this request.
+ countryDartId: string, Optional. Country Dart ID. If not specified, defaults to 256 (US).
+ tvDataProvider: string, Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`.
+ Allowed values
+ INVALID_TV_DATA_PROVIDER -
+ IBOPE_AR -
+ IBOPE_BR -
+ IBOPE_CL -
+ IBOPE_CO -
+ TNS_VN -
+ COMSCORE_NATIONAL_US -
+ COMSCORE_CA -
+ SAMBA_AU -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/dfareporting_v5.tvCampaignSummaries.html b/docs/dyn/dfareporting_v5.tvCampaignSummaries.html
index 64f3951..d9e27ea 100644
--- a/docs/dyn/dfareporting_v5.tvCampaignSummaries.html
+++ b/docs/dyn/dfareporting_v5.tvCampaignSummaries.html
@@ -78,7 +78,7 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#list">list(profileId, accountId=None, name=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(profileId, accountId=None, countryDartId=None, name=None, tvDataProvider=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of TV campaign summaries.</p>
<h3>Method Details</h3>
<div class="method">
@@ -87,13 +87,25 @@
</div>
<div class="method">
- <code class="details" id="list">list(profileId, accountId=None, name=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(profileId, accountId=None, countryDartId=None, name=None, tvDataProvider=None, x__xgafv=None)</code>
<pre>Retrieves a list of TV campaign summaries.
Args:
profileId: string, Required. User profile ID associated with this request. (required)
accountId: string, Required. Account ID associated with this request.
+ countryDartId: string, Optional. Country Dart ID. If not specified, defaults to 256 (US).
name: string, Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.
+ tvDataProvider: string, Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`.
+ Allowed values
+ INVALID_TV_DATA_PROVIDER -
+ IBOPE_AR -
+ IBOPE_BR -
+ IBOPE_CL -
+ IBOPE_CO -
+ TNS_VN -
+ COMSCORE_NATIONAL_US -
+ COMSCORE_CA -
+ SAMBA_AU -
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
index fab3dd2..fedec10 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
@@ -119,13 +119,16 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, engineId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a Engine.</p>
+<p class="firstline">Creates an Engine.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a Engine.</p>
+<p class="firstline">Deletes an Engine.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a Engine.</p>
+<p class="firstline">Gets an Engine.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the Engines associated with the project.</p>
@@ -135,6 +138,9 @@
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an Engine</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -143,7 +149,7 @@
<div class="method">
<code class="details" id="create">create(parent, body=None, engineId=None, x__xgafv=None)</code>
- <pre>Creates a Engine.
+ <pre>Creates an Engine.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. (required)
@@ -277,7 +283,7 @@
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a Engine.
+ <pre>Deletes an Engine.
Args:
name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. (required)
@@ -312,7 +318,7 @@
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets a Engine.
+ <pre>Gets an Engine.
Args:
name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required)
@@ -421,6 +427,41 @@
</div>
<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
+ <pre>Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the Engines associated with the project.
@@ -761,4 +802,62 @@
}</pre>
</div>
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
+ <pre>Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html
index 697d5ce..b22e9a0 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.licenseConfigs.html
@@ -103,6 +103,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -133,6 +139,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -169,6 +181,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -200,6 +218,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -230,6 +254,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
diff --git a/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html b/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html
index 7015c72..2fd853a 100644
--- a/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html
@@ -141,8 +141,15 @@
},
],
"languageCode": "A String", # Optional. The language code used for notifications
+ "regionCode": "A String", # Optional. The region code used of the user that subscribed to the alert policy.
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -180,6 +187,12 @@
{ # Information about license configs at billing account level.
"autoRenew": True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed subscription end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -225,6 +238,12 @@
"billingAccountLicenseConfigs": [ # All BillingAccountLicenseConfigs for the given billing account.
{ # Information about license configs at billing account level.
"autoRenew": True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed subscription end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -309,8 +328,15 @@
},
],
"languageCode": "A String", # Optional. The language code used for notifications
+ "regionCode": "A String", # Optional. The region code used of the user that subscribed to the alert policy.
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.html b/docs/dyn/discoveryengine_v1alpha.projects.html
index caf7f4f..b9499f5 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.html
@@ -131,6 +131,11 @@
"createTime": "A String", # Output only. The timestamp when this project is created.
"customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
"notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+ "dataProtectionPolicy": { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
+ "policy": "A String", # Optional. The Sensitive Data Protection policy resource name.
+ },
+ },
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
"responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
@@ -177,6 +182,11 @@
"createTime": "A String", # Output only. The timestamp when this project is created.
"customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
"notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+ "dataProtectionPolicy": { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
+ "policy": "A String", # Optional. The Sensitive Data Protection policy resource name.
+ },
+ },
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
"responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
@@ -222,6 +232,11 @@
"createTime": "A String", # Output only. The timestamp when this project is created.
"customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
"notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+ "dataProtectionPolicy": { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
+ "policy": "A String", # Optional. The Sensitive Data Protection policy resource name.
+ },
+ },
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
"responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
@@ -329,6 +344,11 @@
"createTime": "A String", # Output only. The timestamp when this project is created.
"customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
"notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+ "dataProtectionPolicy": { # Data protection policy config for NotebookLM. # Optional. Specifies the data protection policy for NotebookLM.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy.
+ "policy": "A String", # Optional. The Sensitive Data Protection policy resource name.
+ },
+ },
"modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
"responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
"userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html
index 7c6a6fe..ab96a28 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html
@@ -189,7 +189,7 @@
<pre>Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.
Args:
- parent: string, Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collection_id}/dataConnector (required)
+ parent: string, Required. Connector name of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector` (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
index 25c8cf0..33e3ea3 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
@@ -162,6 +162,38 @@
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
},
"query": { # Defines a user inputed query. # Required. Current user query.
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -240,6 +272,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -728,6 +761,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1829,6 +1894,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -1890,6 +1956,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -2475,6 +2542,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -2536,6 +2604,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -3091,6 +3160,38 @@
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
},
"query": { # Defines a user inputed query. # Required. Current user query.
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -3169,6 +3270,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -3657,6 +3759,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html
index 88831f1..dc08ba1 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html
@@ -380,6 +380,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -664,6 +696,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -974,6 +1038,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1272,6 +1368,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1574,6 +1702,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1859,6 +2019,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html
index 9cff4ce..019fa2c 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html
@@ -94,21 +94,9 @@
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an Agent.</p>
<p class="toc_element">
- <code><a href="#disableAgent">disableAgent(name, revisionId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.</p>
-<p class="toc_element">
- <code><a href="#enableAgent">enableAgent(name, revisionId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.</p>
-<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an Agent.</p>
<p class="toc_element">
- <code><a href="#getAgentView">getAgentView(name, adminView=None, languageCode=None, maxSuggestedPrompts=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a AgentView for a given Agent, which contains additional information about the Agent.</p>
-<p class="toc_element">
- <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.</p>
-<p class="toc_element">
<code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all Agents under an Assistant which were created by the caller.</p>
<p class="toc_element">
@@ -117,12 +105,6 @@
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an Agent</p>
-<p class="toc_element">
- <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.</p>
-<p class="toc_element">
- <code><a href="#suspendAgent">suspendAgent(name, suspensionReason=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -281,136 +263,6 @@
</div>
<div class="method">
- <code class="details" id="disableAgent">disableAgent(name, revisionId=None, x__xgafv=None)</code>
- <pre>Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.
-
-Args:
- name: string, Required. The name of the Agent to disable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
- revisionId: string, Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Performs a predefined, specific task.
- "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
- "cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
- "entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
- "order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
- },
- "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
- },
- "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
- "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
- "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
- },
- },
- "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
- "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
- "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
- "A String",
- ],
- },
- "createTime": "A String", # Output only. Timestamp when this Agent was created.
- "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
- "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
- "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
- "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
- "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
- },
- "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
- "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
- "content": "A String", # Base64-encoded image file contents.
- "uri": "A String", # Image URI.
- },
- "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
- "managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
- },
- "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
- "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
- "sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
- "scope": "A String", # Optional. The sharing scope of the agent.
- },
- "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
- { # The starter prompt suggestion to show the user on the landing page of the agent.
- "text": "A String", # Required. The text of the starter prompt.
- },
- ],
- "state": "A String", # Output only. The lifecycle state of the agent.
- "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
- "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="enableAgent">enableAgent(name, revisionId=None, x__xgafv=None)</code>
- <pre>Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.
-
-Args:
- name: string, Required. The name of the Agent to enable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
- revisionId: string, Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Performs a predefined, specific task.
- "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
- "cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
- "entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
- "order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
- },
- "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
- },
- "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
- "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
- "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
- },
- },
- "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
- "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
- "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
- "A String",
- ],
- },
- "createTime": "A String", # Output only. Timestamp when this Agent was created.
- "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
- "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
- "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
- "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
- "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
- },
- "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
- "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
- "content": "A String", # Base64-encoded image file contents.
- "uri": "A String", # Image URI.
- },
- "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
- "managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
- },
- "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
- "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
- "sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
- "scope": "A String", # Optional. The sharing scope of the agent.
- },
- "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
- { # The starter prompt suggestion to show the user on the landing page of the agent.
- "text": "A String", # Required. The text of the starter prompt.
- },
- ],
- "state": "A String", # Output only. The lifecycle state of the agent.
- "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
- "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
-}</pre>
-</div>
-
-<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an Agent.
@@ -475,98 +327,6 @@
</div>
<div class="method">
- <code class="details" id="getAgentView">getAgentView(name, adminView=None, languageCode=None, maxSuggestedPrompts=None, x__xgafv=None)</code>
- <pre>Returns a AgentView for a given Agent, which contains additional information about the Agent.
-
-Args:
- name: string, Required. The name of the Agent to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
- adminView: boolean, Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.
- languageCode: string, Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.
- maxSuggestedPrompts: integer, Optional. The maximum number of suggested prompts to return per agent.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Response message for the AgentService.GetAgentView method.
- "agentView": { # The data for displaying an Agent. # The data for displaying an Agent.
- "agentOrigin": "A String", # Immutable. The origin of the Agent.
- "agentSharingState": "A String", # Output only. The sharing state of the agent.
- "agentType": "A String", # Output only. The type of the agent.
- "customPlaceholderText": "A String", # The custom placeholder text that appears in the text box before the user enters any text.
- "deploymentFailureReason": "A String", # The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
- "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query and to generate the first version of the steps for the agent that can be modified by the user. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
- "displayName": "A String", # Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
- "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
- "content": "A String", # Base64-encoded image file contents.
- "uri": "A String", # Image URI.
- },
- "name": "A String", # Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
- "rejectionReason": "A String", # The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
- "state": "A String", # Output only. The state of the Agent.
- "suggestedPrompts": [ # Optional. The suggested prompts for the agent, to be shown on the agent landing page.
- { # A suggested prompt for the agent, to be shown on the agent landing page.
- "text": "A String", # Required. The text of the suggested prompt. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
- },
- ],
- "suspensionReason": "A String", # The reason why the agent was suspended. Only set if the state is SUSPENDED.
- "updateTime": "A String", # Output only. The timestamp when the agent was last updated.
- "userAnnotations": { # Per-user annotations for an Agent, based on UserAnnotation. # Optional. Per-user annotations of the current caller for the agent.
- "pinned": True or False, # Optional. Whether the agent is pinned, pinned agent will be displayed on the top of the agent list.
- "viewed": True or False, # Optional. Whether the agent has been viewed by the user.
- },
- "userPermissions": { # The permissions of the user on an Agent. # The permissions of the user for this Agent.
- "canDelete": True or False, # If the user can delete this Agent.
- "canEdit": True or False, # If the user can edit this Agent.
- "canProposeUsers": True or False, # If the user can propose other users to share the Agent with.
- "canRequestReview": True or False, # If the user can request a review for this Agent.
- "canRun": True or False, # If the user can run this Agent.
- "canView": True or False, # If the user can view the source of this Agent.
- "canWithdraw": True or False, # If the user can withdraw this Agent.
- },
- },
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
- <pre>Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
-
-Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
- options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
- { # Associates `members`, or principals, with a `role`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
- },
- "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
- "A String",
- ],
- "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-}</pre>
-</div>
-
-<div class="method">
<code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all Agents under an Assistant which were created by the caller.
@@ -769,127 +529,4 @@
}</pre>
</div>
-<div class="method">
- <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
- <pre>Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.
-
-Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
- "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
- { # Associates `members`, or principals, with a `role`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
- },
- "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
- "A String",
- ],
- "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
- { # Associates `members`, or principals, with a `role`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
- },
- "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
- "A String",
- ],
- "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="suspendAgent">suspendAgent(name, suspensionReason=None, x__xgafv=None)</code>
- <pre>Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.
-
-Args:
- name: string, Required. The name of the Agent to suspend. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
- suspensionReason: string, Required. The reason for suspending the Agent. This will be shown to the users of the Agent.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Performs a predefined, specific task.
- "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
- "cloudMarketplaceConfig": { # Configuration specific to agents that are deployed from Cloud Marketplace. # Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
- "entitlement": "A String", # Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project}/entitlements/{entitlement}`.
- "order": "A String", # Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account}/orders/{order}`
- },
- "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
- },
- "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
- "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
- "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
- },
- },
- "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
- "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
- "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
- "A String",
- ],
- },
- "createTime": "A String", # Output only. Timestamp when this Agent was created.
- "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
- "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
- "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
- "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
- "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
- },
- "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
- "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
- "content": "A String", # Base64-encoded image file contents.
- "uri": "A String", # Image URI.
- },
- "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
- "managedAgentDefinition": { # Stores the definition of a Google managed agent. # Optional. The behavior of the Google managed agent.
- },
- "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
- "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
- "sharingConfig": { # Sharing related configuration. # Optional. The sharing config of the agent.
- "scope": "A String", # Optional. The sharing scope of the agent.
- },
- "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
- { # The starter prompt suggestion to show the user on the landing page of the agent.
- "text": "A String", # Required. The text of the starter prompt.
- },
- ],
- "state": "A String", # Output only. The lifecycle state of the agent.
- "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
- "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
-}</pre>
-</div>
-
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
index c6b29c9..d8fb4b9 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
@@ -100,12 +100,6 @@
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all Assistants under an Engine.</p>
<p class="toc_element">
- <code><a href="#listAvailableAgentViews">listAvailableAgentViews(parent, adminView=None, agentOrigin=None, filter=None, languageCode=None, maxSuggestedPrompts=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists the data for displaying the Agents under an Assistant which are available to the caller.</p>
-<p class="toc_element">
- <code><a href="#listAvailableAgentViews_next">listAvailableAgentViews_next()</a></code></p>
-<p class="firstline">Retrieves the next page of results.</p>
-<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
@@ -367,90 +361,6 @@
</div>
<div class="method">
- <code class="details" id="listAvailableAgentViews">listAvailableAgentViews(parent, adminView=None, agentOrigin=None, filter=None, languageCode=None, maxSuggestedPrompts=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None)</code>
- <pre>Lists the data for displaying the Agents under an Assistant which are available to the caller.
-
-Args:
- parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
- adminView: boolean, Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.
- agentOrigin: string, Optional. The origin of the Agent.
- Allowed values
- AGENT_ORIGIN_UNSPECIFIED - The origin is unspecified.
- GOOGLE - Agent defined by Google.
- ORGANIZATION - Agent defined by the organization.
- USER - Agent defined by the user.
- filter: string, Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Allowed fields are: * `display_name` * `state` Some examples of filters would be: * `display_name = 'agent_1'` * `display_name = 'agent_1' AND state = ENABLED` For a full description of the filter format, please see https://google.aip.dev/160.
- languageCode: string, Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentViews in the response should be translated to this language.
- maxSuggestedPrompts: integer, Optional. The maximum number of suggested prompts to return per agent.
- pageSize: integer, Optional. Maximum number of AgentViews to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
- pageToken: string, Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableAgentViews must match the call that provided the page token.
- sortBy: string, Optional. The field to sort by. Can have the following values: - display-name: The display name of the agent. - description: The description of the agent. - create-time: The creation time of the agent. - state: The state of the agent.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Response message for the AgentService.ListAvailableAgentViews method.
- "agentViews": [ # The agent sources visible to the caller under the parent Assistant.
- { # The data for displaying an Agent.
- "agentOrigin": "A String", # Immutable. The origin of the Agent.
- "agentSharingState": "A String", # Output only. The sharing state of the agent.
- "agentType": "A String", # Output only. The type of the agent.
- "customPlaceholderText": "A String", # The custom placeholder text that appears in the text box before the user enters any text.
- "deploymentFailureReason": "A String", # The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
- "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query and to generate the first version of the steps for the agent that can be modified by the user. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
- "displayName": "A String", # Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
- "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
- "content": "A String", # Base64-encoded image file contents.
- "uri": "A String", # Image URI.
- },
- "name": "A String", # Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
- "rejectionReason": "A String", # The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
- "state": "A String", # Output only. The state of the Agent.
- "suggestedPrompts": [ # Optional. The suggested prompts for the agent, to be shown on the agent landing page.
- { # A suggested prompt for the agent, to be shown on the agent landing page.
- "text": "A String", # Required. The text of the suggested prompt. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.
- },
- ],
- "suspensionReason": "A String", # The reason why the agent was suspended. Only set if the state is SUSPENDED.
- "updateTime": "A String", # Output only. The timestamp when the agent was last updated.
- "userAnnotations": { # Per-user annotations for an Agent, based on UserAnnotation. # Optional. Per-user annotations of the current caller for the agent.
- "pinned": True or False, # Optional. Whether the agent is pinned, pinned agent will be displayed on the top of the agent list.
- "viewed": True or False, # Optional. Whether the agent has been viewed by the user.
- },
- "userPermissions": { # The permissions of the user on an Agent. # The permissions of the user for this Agent.
- "canDelete": True or False, # If the user can delete this Agent.
- "canEdit": True or False, # If the user can edit this Agent.
- "canProposeUsers": True or False, # If the user can propose other users to share the Agent with.
- "canRequestReview": True or False, # If the user can request a review for this Agent.
- "canRun": True or False, # If the user can run this Agent.
- "canView": True or False, # If the user can view the source of this Agent.
- "canWithdraw": True or False, # If the user can withdraw this Agent.
- },
- },
- ],
- "nextPageToken": "A String", # A token that can be sent as ListAvailableAgentViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
-}</pre>
-</div>
-
-<div class="method">
- <code class="details" id="listAvailableAgentViews_next">listAvailableAgentViews_next()</code>
- <pre>Retrieves the next page of results.
-
- Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
- Returns:
- A request object that you can call 'execute()' on to request the next
- page. Returns None if there are no more items in the collection.
- </pre>
-</div>
-
-<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
@@ -579,10 +489,45 @@
The object takes the form of:
{ # Request for the AssistantService.StreamAssist method.
+ "actionSpec": { # Specification of actions for the request. # Optional. Specification of actions for the request.
+ "actionDisabled": True or False, # Optional. If true, actions will not be served for the request. This only works for enterprise edition.
+ },
"generationSpec": { # Assistant generation specification for the request. This allows to override the default generation configuration at the engine level. # Optional. Specification of the generation configuration for the request.
"modelId": "A String", # Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used.
},
"query": { # Defines a user inputed query. # Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files.
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -615,6 +560,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
index 2941b0f..9f59570 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
@@ -124,13 +124,16 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, engineId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a Engine.</p>
+<p class="firstline">Creates an Engine.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a Engine.</p>
+<p class="firstline">Deletes an Engine.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a Engine.</p>
+<p class="firstline">Gets an Engine.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.</p>
<p class="toc_element">
<code><a href="#getWorkspaceSettings">getWorkspaceSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get Workspace settings for the end user.</p>
@@ -145,13 +148,16 @@
<p class="firstline">Updates an Engine</p>
<p class="toc_element">
<code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="firstline">Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
<p class="toc_element">
<code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="firstline">Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.</p>
<p class="toc_element">
<code><a href="#tune">tune(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="firstline">Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -160,7 +166,7 @@
<div class="method">
<code class="details" id="create">create(parent, body=None, engineId=None, x__xgafv=None)</code>
- <pre>Creates a Engine.
+ <pre>Creates an Engine.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. (required)
@@ -303,7 +309,7 @@
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a Engine.
+ <pre>Deletes an Engine.
Args:
name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. (required)
@@ -338,7 +344,7 @@
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets a Engine.
+ <pre>Gets an Engine.
Args:
name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required)
@@ -456,6 +462,41 @@
</div>
<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
+ <pre>Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="getWorkspaceSettings">getWorkspaceSettings(name, x__xgafv=None)</code>
<pre>Get Workspace settings for the end user.
@@ -844,7 +885,7 @@
<div class="method">
<code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code>
- <pre>Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
+ <pre>Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
Args:
name: string, Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` (required)
@@ -969,7 +1010,7 @@
<div class="method">
<code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>
- <pre>Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
+ <pre>Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
Args:
name: string, Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` (required)
@@ -1093,8 +1134,66 @@
</div>
<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
+ <pre>Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="tune">tune(name, body=None, x__xgafv=None)</code>
- <pre>Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
+ <pre>Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
Args:
name: string, Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` (required)
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
index f9b3f28..d9ef8d2 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
@@ -162,6 +162,38 @@
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
},
"query": { # Defines a user inputed query. # Required. Current user query.
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -240,6 +272,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -728,6 +761,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1829,6 +1894,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -1890,6 +1956,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -2475,6 +2542,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -2536,6 +2604,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -3091,6 +3160,38 @@
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
},
"query": { # Defines a user inputed query. # Required. Current user query.
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -3169,6 +3270,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -3657,6 +3759,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html
index 1f097c8..60f0d2a 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html
@@ -395,6 +395,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -679,6 +711,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -989,6 +1053,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1287,6 +1383,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1589,6 +1717,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1874,6 +2034,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
index 61291a6..3c05ffd 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
@@ -216,6 +216,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
@@ -446,6 +451,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
@@ -680,6 +690,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
@@ -924,6 +939,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
@@ -1178,6 +1198,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
@@ -1399,6 +1424,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
index 22b24c3..9c1a29f 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
@@ -162,6 +162,38 @@
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
},
"query": { # Defines a user inputed query. # Required. Current user query.
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -240,6 +272,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -728,6 +761,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1829,6 +1894,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -1890,6 +1956,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -2475,6 +2542,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -2536,6 +2604,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -3091,6 +3160,38 @@
"includeGroundingSupports": True or False, # Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim.
},
"query": { # Defines a user inputed query. # Required. Current user query.
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -3169,6 +3270,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -3657,6 +3759,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html
index 1478d5c..9cbb486 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html
@@ -380,6 +380,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -664,6 +696,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -974,6 +1038,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1272,6 +1368,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1574,6 +1702,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
@@ -1859,6 +2019,38 @@
"state": "A String", # State of the answer generation.
},
"query": { # Defines a user inputed query. # Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn
+ "parts": [ # Query content parts.
+ { # Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.
+ "documentReference": { # Represents a document reference. # Other VAIS Document references.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
+ "fileId": "A String", # Output only. The file id of the document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the reference.
+ "urlForConnector": "A String", # Input only. The url_for_connector of the document returned by Federated Search.
+ },
+ "driveDocumentReference": { # Represents a Google Drive document reference. # Reference to a Google Drive document.
+ "destinationUri": "A String", # The destination uri of the reference.
+ "displayTitle": "A String", # The display title of the reference.
+ "documentName": "A String", # The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "driveId": "A String", # The Drive id of the document.
+ "fileId": "A String", # Output only. The file id of the Drive document data stored in the session context files.
+ "iconUri": "A String", # The icon uri of the Drive document reference.
+ },
+ "mimeType": "A String", # Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is "text/plain" for the "data" field.
+ "personReference": { # Represents a person reference. # Reference to a person.
+ "destinationUri": "A String", # The destination uri of the person.
+ "displayName": "A String", # The display name of the person.
+ "displayPhotoUri": "A String", # The display photo url of the person.
+ "documentName": "A String", # The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+ "email": "A String", # The email of the person.
+ "fileId": "A String", # Output only. The file id of the person data stored in the session context files.
+ "personId": "A String", # The person id of the person.
+ },
+ "text": "A String", # Text content.
+ "uiJsonPayload": "A String", # This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
+ },
+ ],
"queryId": "A String", # Output only. Unique Id for the query.
"text": "A String", # Plain text.
},
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
index f07ed2a..16c68cf 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
@@ -236,6 +236,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -297,6 +298,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -563,6 +565,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -624,6 +627,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -866,6 +870,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -927,6 +932,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
index 9cc2b61..9dbe449 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
@@ -158,6 +158,9 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
+ <code><a href="#completeExternalIdentities">completeExternalIdentities(parent, entityTypeFilter=None, maxSuggestions=None, prefixQuery=None, useScimIdentities=None, x__xgafv=None)</a></code></p>
+<p class="firstline">This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix.</p>
+<p class="toc_element">
<code><a href="#estimateDataSize">estimateDataSize(location, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Estimates the data size to be used by a customer.</p>
<p class="toc_element">
@@ -197,6 +200,45 @@
</div>
<div class="method">
+ <code class="details" id="completeExternalIdentities">completeExternalIdentities(parent, entityTypeFilter=None, maxSuggestions=None, prefixQuery=None, useScimIdentities=None, x__xgafv=None)</code>
+ <pre>This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix.
+
+Args:
+ parent: string, Required. The parent location resource name, such as `projects/*/locations/global`. (required)
+ entityTypeFilter: string, Optional. The type of entities to fetch. If not set, all entity types will be returned.
+ Allowed values
+ ENTITY_TYPE_FILTER_UNSPECIFIED - Unspecified entity type filter.
+ USERS - Fetch only users.
+ GROUPS - Fetch only groups.
+ maxSuggestions: integer, Optional. The maximum number of user and group results to return. The service may return fewer than this value. If unspecified, at most 6 results will be returned. The limit is distributed as evenly as possible across users and groups. For example, if max_suggestions is 7, the service may return 4 users and 3 groups. If there are fewer suggestions of one type than half the limit, the other type may return more suggestions up to the max_suggestions limit.
+ prefixQuery: string, Required. The prefix to search for. For users, this prefix is matched against the `primary_email`. For groups, this prefix is matched against the `display_name`. The matching is case-insensitive.
+ useScimIdentities: boolean, Optional. Whether to use scim identities for external identity completion. If false, we will call the Microsoft graph API to fetch the external identities.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for CompletionService.CompleteExternalIdentities.
+ "externalIdentities": [ # The list of external identities that match the query.
+ { # External identity representing either a user or group. This user or group is from an external identity provider (IdP).
+ "displayName": "A String", # The display name of the user or group.
+ "externalId": "A String", # The unique 3P ID(external_id) of the entity (user or group).
+ "groupMetadata": { # Metadata corresponding to the external group. # Metadata corresponding to the external user.
+ },
+ "userMetadata": { # Metadata corresponding to the external user. # Metadata corresponding to the external user.
+ "familyName": "A String", # The user's family name.
+ "givenName": "A String", # The user's given name.
+ "primaryEmail": "A String", # The user's primary email address.
+ },
+ },
+ ],
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="estimateDataSize">estimateDataSize(location, body=None, x__xgafv=None)</code>
<pre>Estimates the data size to be used by a customer.
@@ -1041,6 +1083,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
@@ -1292,6 +1339,11 @@
"connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
"createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
"createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+ "dataProtectionPolicy": { # Data protection policy config for a connector. # Optional. Specifies the data protection policy for the connector.
+ "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. The sensitive data protection policy for the connector source.
+ "policy": "A String", # Optional. The Sensitive Data Protection content policy resource name.
+ },
+ },
"dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
"destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
{ # Defines target endpoints used to connect to third-party sources.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html
index e7824d7..449dab1 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.licenseConfigs.html
@@ -119,8 +119,15 @@
},
],
"languageCode": "A String", # Optional. The language code used for notifications
+ "regionCode": "A String", # Optional. The region code used of the user that subscribed to the alert policy.
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -167,8 +174,15 @@
},
],
"languageCode": "A String", # Optional. The language code used for notifications
+ "regionCode": "A String", # Optional. The region code used of the user that subscribed to the alert policy.
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -221,8 +235,15 @@
},
],
"languageCode": "A String", # Optional. The language code used for notifications
+ "regionCode": "A String", # Optional. The region code used of the user that subscribed to the alert policy.
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -270,8 +291,15 @@
},
],
"languageCode": "A String", # Optional. The language code used for notifications
+ "regionCode": "A String", # Optional. The region code used of the user that subscribed to the alert policy.
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -318,8 +346,15 @@
},
],
"languageCode": "A String", # Optional. The language code used for notifications
+ "regionCode": "A String", # Optional. The region code used of the user that subscribed to the alert policy.
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
index 295fc30..4b6d4ac 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
@@ -237,6 +237,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -1774,6 +1775,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -1835,6 +1837,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -2416,6 +2419,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -2477,6 +2481,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -3106,6 +3111,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
index 8b8cbe5..a0ec322 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
@@ -514,6 +514,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
index 805c284..583909e 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
@@ -114,13 +114,16 @@
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, engineId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a Engine.</p>
+<p class="firstline">Creates an Engine.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a Engine.</p>
+<p class="firstline">Deletes an Engine.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a Engine.</p>
+<p class="firstline">Gets an Engine.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the Engines associated with the project.</p>
@@ -132,13 +135,16 @@
<p class="firstline">Updates an Engine</p>
<p class="toc_element">
<code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="firstline">Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
<p class="toc_element">
<code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="firstline">Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.</p>
<p class="toc_element">
<code><a href="#tune">tune(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
+<p class="firstline">Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
@@ -147,7 +153,7 @@
<div class="method">
<code class="details" id="create">create(parent, body=None, engineId=None, x__xgafv=None)</code>
- <pre>Creates a Engine.
+ <pre>Creates an Engine.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. (required)
@@ -281,7 +287,7 @@
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Deletes a Engine.
+ <pre>Deletes an Engine.
Args:
name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. (required)
@@ -316,7 +322,7 @@
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets a Engine.
+ <pre>Gets an Engine.
Args:
name: string, Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required)
@@ -425,6 +431,41 @@
</div>
<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
+ <pre>Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the Engines associated with the project.
@@ -767,7 +808,7 @@
<div class="method">
<code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code>
- <pre>Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
+ <pre>Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
Args:
name: string, Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` (required)
@@ -883,7 +924,7 @@
<div class="method">
<code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>
- <pre>Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
+ <pre>Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
Args:
name: string, Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` (required)
@@ -998,8 +1039,66 @@
</div>
<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
+ <pre>Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="tune">tune(name, body=None, x__xgafv=None)</code>
- <pre>Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
+ <pre>Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
Args:
name: string, Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` (required)
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
index 7b5d7dc..dd6380d 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
@@ -237,6 +237,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -1774,6 +1775,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -1835,6 +1837,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -2416,6 +2419,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -2477,6 +2481,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -3106,6 +3111,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
index d594af4..3fcb721 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
@@ -237,6 +237,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
@@ -1774,6 +1775,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -1835,6 +1837,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -2416,6 +2419,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -2477,6 +2481,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -3106,6 +3111,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
index 95fd95a..79aa3f9 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
@@ -233,6 +233,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -294,6 +295,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -556,6 +558,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -617,6 +620,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -855,6 +859,7 @@
"customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. The path must include the project number, project id is not supported for this field.
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+ "numResults": 42, # Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.
},
],
"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results.
@@ -916,6 +921,7 @@
"A String",
],
},
+ "numResultsPerDataStore": 42, # Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.
"offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
"oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html
index dfd49aa..a33970d 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html
@@ -103,6 +103,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -133,6 +139,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -169,6 +181,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -200,6 +218,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -230,6 +254,12 @@
{ # Information about users' licenses.
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+ "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+ "earlyTerminationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the subscription is terminated earlier than the expiration date.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html
index 44b4762..1f765d4 100644
--- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html
+++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html
@@ -122,8 +122,9 @@
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
@@ -131,19 +132,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
},
@@ -157,19 +159,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -184,16 +187,18 @@
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
@@ -203,19 +208,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -228,8 +234,9 @@
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
@@ -238,12 +245,12 @@
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -265,8 +272,9 @@
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
},
@@ -309,8 +317,9 @@
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
@@ -318,19 +327,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
},
@@ -344,19 +354,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -371,16 +382,18 @@
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
@@ -390,19 +403,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -415,8 +429,9 @@
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
@@ -425,12 +440,12 @@
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -452,8 +467,9 @@
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
},
diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html
index 3b7c557..fd5b6a0 100644
--- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html
+++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html
@@ -243,20 +243,21 @@
},
],
},
- "adUrls": [ # List of URLs used by the ad.
+ "adUrls": [ # Output only. List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
- "advertiserId": "A String", # Required. The unique ID of the advertiser the ad belongs to.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
@@ -264,19 +265,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
},
@@ -290,19 +292,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -317,16 +320,18 @@
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
@@ -336,19 +341,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -361,8 +367,9 @@
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
@@ -371,12 +378,12 @@
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -398,8 +405,9 @@
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
},
@@ -562,20 +570,21 @@
},
],
},
- "adUrls": [ # List of URLs used by the ad.
+ "adUrls": [ # Output only. List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
- "advertiserId": "A String", # Required. The unique ID of the advertiser the ad belongs to.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
"audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
@@ -583,19 +592,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
},
@@ -609,19 +619,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -636,16 +647,18 @@
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
@@ -655,19 +668,20 @@
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -680,8 +694,9 @@
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
@@ -690,12 +705,12 @@
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -717,8 +732,9 @@
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
},
diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html
index 3d8f7e8..3c0732e 100644
--- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html
+++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html
@@ -487,10 +487,10 @@
An object of the form:
{ # A single ad group associated with a line item.
- "adGroupFormat": "A String", # The format of the ads in the ad group.
- "adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
- "advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
+ "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+ "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
@@ -513,11 +513,11 @@
"value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
},
},
- "displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
- "entityStatus": "A String", # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
- "lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
- "name": "A String", # The resource name of the ad group.
- "productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
+ "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+ "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+ "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+ "name": "A String", # Output only. Identifier. The resource name of the ad group.
+ "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
"isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
"productMatchDimensions": [ # A list of dimensions used to match products.
{ # A dimension used to match products.
@@ -530,7 +530,7 @@
],
"productMatchType": "A String", # How products are selected by the product feed.
},
- "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+ "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
"enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
@@ -559,10 +559,10 @@
{
"adGroups": [ # The list of ad groups. This list will be absent if empty.
{ # A single ad group associated with a line item.
- "adGroupFormat": "A String", # The format of the ads in the ad group.
- "adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
- "advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
+ "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+ "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
@@ -585,11 +585,11 @@
"value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
},
},
- "displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
- "entityStatus": "A String", # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
- "lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
- "name": "A String", # The resource name of the ad group.
- "productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
+ "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+ "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+ "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+ "name": "A String", # Output only. Identifier. The resource name of the ad group.
+ "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
"isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
"productMatchDimensions": [ # A list of dimensions used to match products.
{ # A dimension used to match products.
@@ -602,7 +602,7 @@
],
"productMatchType": "A String", # How products are selected by the product feed.
},
- "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+ "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
"enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html
index d401b3c..06193e4 100644
--- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html
+++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html
@@ -109,7 +109,7 @@
{ # A single ad associated with an ad group.
"adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
- "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.
+ "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
"adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
"adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
"adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
@@ -243,73 +243,76 @@
},
],
},
- "adUrls": [ # List of URLs used by the ad.
+ "adUrls": [ # Output only. List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
"advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
- "audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+ "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
- "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+ "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
},
- "displayName": "A String", # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
- "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
+ "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+ "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
"creativeId": "A String", # The ID of the source creative.
},
- "entityStatus": "A String", # The entity status of the ad.
- "inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+ "entityStatus": "A String", # Required. The entity status of the ad.
+ "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
- "mastheadAd": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+ "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
"autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
"autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
"callToActionButtonLabel": "A String", # The text on the call-to-action button.
@@ -317,66 +320,70 @@
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # Output only. The resource name of the ad.
- "nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+ "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
- "videoDiscoverAd": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+ "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
- "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+ "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
"actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -398,8 +405,9 @@
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
},
@@ -428,7 +436,7 @@
"adGroupAds": [ # The list of ads. This list will be absent if empty.
{ # A single ad associated with an ad group.
"adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system.
- "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.
+ "adGroupId": "A String", # Required. The unique ID of the ad group that the ad belongs to.
"adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad.
"adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
"adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
@@ -562,73 +570,76 @@
},
],
},
- "adUrls": [ # List of URLs used by the ad.
+ "adUrls": [ # Output only. List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
"advertiserId": "A String", # Output only. The unique ID of the advertiser the ad belongs to.
- "audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
+ "audioAd": { # Details for an audio ad. # Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
- "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
+ "bumperAd": { # Details for a bumper ad. # Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
},
- "displayName": "A String", # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
- "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
+ "displayName": "A String", # Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
+ "displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Output only. Details of an ad sourced from a Display & Video 360 creative.
"creativeId": "A String", # The ID of the source creative.
},
- "entityStatus": "A String", # The entity status of the ad.
- "inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
+ "entityStatus": "A String", # Required. The entity status of the ad.
+ "inStreamAd": { # Details for an in-stream ad. # Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
- "mastheadAd": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
+ "mastheadAd": { # Details for a Masthead Ad. # Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
"autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
"autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
"callToActionButtonLabel": "A String", # The text on the call-to-action button.
@@ -636,66 +647,70 @@
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # Output only. The resource name of the ad.
- "nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
+ "nonSkippableAd": { # Details for a non-skippable ad. # Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
- "videoDiscoverAd": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
+ "videoDiscoverAd": { # Details for a video discovery ad. # Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
},
- "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
+ "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
"actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
- "fileSize": "A String", # File size of the image asset in bytes.
- "fullSize": { # Dimensions. # Metadata for this image at its original size.
+ "fileSize": "A String", # Output only. File size of the image asset in bytes.
+ "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
- "mimeType": "A String", # MIME type of the image asset.
+ "mimeType": "A String", # Output only. MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
@@ -717,8 +732,9 @@
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
- "id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
+ "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
+ "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id.
},
],
},
diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html
index e2322f4..bb08cfb 100644
--- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html
+++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html
@@ -492,10 +492,10 @@
An object of the form:
{ # A single ad group associated with a line item.
- "adGroupFormat": "A String", # The format of the ads in the ad group.
- "adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
- "advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
+ "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+ "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
@@ -518,11 +518,11 @@
"value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
},
},
- "displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
- "entityStatus": "A String", # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
- "lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
- "name": "A String", # The resource name of the ad group.
- "productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
+ "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+ "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+ "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+ "name": "A String", # Output only. Identifier. The resource name of the ad group.
+ "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
"isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
"productMatchDimensions": [ # A list of dimensions used to match products.
{ # A dimension used to match products.
@@ -535,7 +535,7 @@
],
"productMatchType": "A String", # How products are selected by the product feed.
},
- "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+ "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
"enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
@@ -564,10 +564,10 @@
{
"adGroups": [ # The list of ad groups. This list will be absent if empty.
{ # A single ad group associated with a line item.
- "adGroupFormat": "A String", # The format of the ads in the ad group.
- "adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
- "advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
+ "adGroupFormat": "A String", # Required. The format of the ads in the ad group.
+ "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
@@ -590,11 +590,11 @@
"value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
},
},
- "displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
- "entityStatus": "A String", # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
- "lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
- "name": "A String", # The resource name of the ad group.
- "productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
+ "displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
+ "entityStatus": "A String", # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
+ "lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
+ "name": "A String", # Output only. Identifier. The resource name of the ad group.
+ "productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
"isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
"productMatchDimensions": [ # A list of dimensions used to match products.
{ # A dimension used to match products.
@@ -607,7 +607,7 @@
],
"productMatchType": "A String", # How products are selected by the product feed.
},
- "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
+ "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
"enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
diff --git a/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html b/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html
index cc7d736..63ccd60 100644
--- a/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html
+++ b/docs/dyn/firebaseappcheck_v1.projects.services.resourcePolicies.html
@@ -112,7 +112,7 @@
"requests": [ # Required. The request messages specifying the ResourcePolicy objects to update. A maximum of 100 objects can be updated in a batch.
{ # Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method.
"resourcePolicy": { # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. # Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -135,7 +135,7 @@
{ # Response message for the BatchUpdateResourcePolicies method.
"resourcePolicies": [ # ResourcePolicy objects after the updates have been applied.
{ # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -160,7 +160,7 @@
The object takes the form of:
{ # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -176,7 +176,7 @@
An object of the form:
{ # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -218,7 +218,7 @@
An object of the form:
{ # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -247,7 +247,7 @@
"nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted.
"resourcePolicies": [ # The ResourcePolicy objects retrieved.
{ # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -281,7 +281,7 @@
The object takes the form of:
{ # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
@@ -298,7 +298,7 @@
An object of the form:
{ # App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.
- "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.
+ "enforcementMode": "A String", # Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.
"name": "A String", # Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.
"targetResource": "A String", # Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.
diff --git a/docs/dyn/gmailpostmastertools_v2.domainStats.html b/docs/dyn/gmailpostmastertools_v2.domainStats.html
new file mode 100644
index 0000000..263d286
--- /dev/null
+++ b/docs/dyn/gmailpostmastertools_v2.domainStats.html
@@ -0,0 +1,194 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="gmailpostmastertools_v2.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v2.domainStats.html">domainStats</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#batchQuery">batchQuery(body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of the requested domains.</p>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="batchQuery">batchQuery(body=None, x__xgafv=None)</code>
+ <pre>Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of the requested domains.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchQueryDomainStats.
+ "requests": [ # Required. A list of individual query requests. Each request can be for a different domain. A maximum of 100 requests can be included in a single batch.
+ { # Request message for QueryDomainStats.
+ "aggregationGranularity": "A String", # Optional. The granularity at which to aggregate the statistics. If unspecified, defaults to DAILY.
+ "metricDefinitions": [ # Required. The specific metrics to query. You can define a custom name for each metric, which will be used in the response.
+ { # Defines a specific metric to query, including a user-defined name, the base metric type, and optional filters.
+ "baseMetric": { # Specifies the base metric to query, which can be a predefined standard metric or a user-defined custom metric (if supported in the future). # Required. The underlying metric to query.
+ "standardMetric": "A String", # A predefined standard metric.
+ },
+ "filter": "A String", # Optional. Optional filters to apply to the metric.
+ "name": "A String", # Required. The user-defined name for this metric. This name will be used as the key for this metric's value in the response.
+ },
+ ],
+ "pageSize": 42, # Optional. The maximum number of DomainStats resources to return in the response. The server may return fewer than this value. If unspecified, a default value of 10 will be used. The maximum value is 200.
+ "pageToken": "A String", # Optional. The next_page_token value returned from a previous List request, if any. If the aggregation granularity is DAILY, the page token will be the encoded date + "/" + metric name. If the aggregation granularity is OVERALL, the page token will be the encoded metric name.
+ "parent": "A String", # Required. The parent resource name where the stats are queried. Format: domains/{domain}
+ "timeQuery": { # The date ranges or specific dates for which you want to retrieve data. # Required. The time range or specific dates for which to retrieve the metrics.
+ "dateList": { # A set of specific dates. # A list of specific dates.
+ "dates": [ # Required. The list of specific dates for which to retrieve data.
+ { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ ],
+ },
+ "dateRanges": { # A set of date ranges. # A list of date ranges.
+ "dateRanges": [ # Required. The list of date ranges for which to retrieve data.
+ { # A single date range defined by a start and end date.
+ "end": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The inclusive end date of the date range.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "start": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The inclusive start date of the date range.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ },
+ ],
+ },
+ },
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for BatchQueryDomainStats.
+ "results": [ # A list of responses, one for each query in the BatchQueryDomainStatsRequest. The order of responses will correspond to the order of requests.
+ { # Represents the result of a single QueryDomainStatsRequest within a batch.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error status if the individual query failed.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "response": { # Response message for QueryDomainStats. # The successful response for the individual query.
+ "domainStats": [ # The list of domain statistics. Each DomainStat object contains the value for a metric requested in the QueryDomainStatsRequest.
+ { # Email statistics for a domain for a specified time period or date.
+ "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The specific date for these stats, if granularity is DAILY. This field is populated if the QueryDomainStatsRequest specified a DAILY aggregation granularity.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "metric": "A String", # The user-defined name from MetricDefinition.name in the request, used to correlate this result with the requested metric.
+ "name": "A String", # Output only. The resource name of the DomainStat resource. Format: domains/{domain}/domainStats/{domain_stat} The `{domain_stat}` segment is an opaque, server-generated ID. We recommend using the `metric` field to identify queried metrics instead of parsing the name.
+ "value": { # The actual value of a statistic. # The value of the corresponding metric.
+ "doubleValue": 3.14, # Double value.
+ "floatValue": 3.14, # Float value.
+ "intValue": "A String", # Integer value.
+ "stringList": { # Represents a list of strings. # List of string values.
+ "values": [ # The string values.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String value.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+ },
+ },
+ ],
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/gmailpostmastertools_v2.domains.domainStats.html b/docs/dyn/gmailpostmastertools_v2.domains.domainStats.html
new file mode 100644
index 0000000..ae579ab
--- /dev/null
+++ b/docs/dyn/gmailpostmastertools_v2.domains.domainStats.html
@@ -0,0 +1,193 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="gmailpostmastertools_v2.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v2.domains.html">domains</a> . <a href="gmailpostmastertools_v2.domains.domainStats.html">domainStats</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#query">query(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain.</p>
+<p class="toc_element">
+ <code><a href="#query_next">query_next()</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="query">query(parent, body=None, x__xgafv=None)</code>
+ <pre>Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain.
+
+Args:
+ parent: string, Required. The parent resource name where the stats are queried. Format: domains/{domain} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for QueryDomainStats.
+ "aggregationGranularity": "A String", # Optional. The granularity at which to aggregate the statistics. If unspecified, defaults to DAILY.
+ "metricDefinitions": [ # Required. The specific metrics to query. You can define a custom name for each metric, which will be used in the response.
+ { # Defines a specific metric to query, including a user-defined name, the base metric type, and optional filters.
+ "baseMetric": { # Specifies the base metric to query, which can be a predefined standard metric or a user-defined custom metric (if supported in the future). # Required. The underlying metric to query.
+ "standardMetric": "A String", # A predefined standard metric.
+ },
+ "filter": "A String", # Optional. Optional filters to apply to the metric.
+ "name": "A String", # Required. The user-defined name for this metric. This name will be used as the key for this metric's value in the response.
+ },
+ ],
+ "pageSize": 42, # Optional. The maximum number of DomainStats resources to return in the response. The server may return fewer than this value. If unspecified, a default value of 10 will be used. The maximum value is 200.
+ "pageToken": "A String", # Optional. The next_page_token value returned from a previous List request, if any. If the aggregation granularity is DAILY, the page token will be the encoded date + "/" + metric name. If the aggregation granularity is OVERALL, the page token will be the encoded metric name.
+ "parent": "A String", # Required. The parent resource name where the stats are queried. Format: domains/{domain}
+ "timeQuery": { # The date ranges or specific dates for which you want to retrieve data. # Required. The time range or specific dates for which to retrieve the metrics.
+ "dateList": { # A set of specific dates. # A list of specific dates.
+ "dates": [ # Required. The list of specific dates for which to retrieve data.
+ { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ ],
+ },
+ "dateRanges": { # A set of date ranges. # A list of date ranges.
+ "dateRanges": [ # Required. The list of date ranges for which to retrieve data.
+ { # A single date range defined by a start and end date.
+ "end": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The inclusive end date of the date range.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "start": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The inclusive start date of the date range.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ },
+ ],
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for QueryDomainStats.
+ "domainStats": [ # The list of domain statistics. Each DomainStat object contains the value for a metric requested in the QueryDomainStatsRequest.
+ { # Email statistics for a domain for a specified time period or date.
+ "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The specific date for these stats, if granularity is DAILY. This field is populated if the QueryDomainStatsRequest specified a DAILY aggregation granularity.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
+ "metric": "A String", # The user-defined name from MetricDefinition.name in the request, used to correlate this result with the requested metric.
+ "name": "A String", # Output only. The resource name of the DomainStat resource. Format: domains/{domain}/domainStats/{domain_stat} The `{domain_stat}` segment is an opaque, server-generated ID. We recommend using the `metric` field to identify queried metrics instead of parsing the name.
+ "value": { # The actual value of a statistic. # The value of the corresponding metric.
+ "doubleValue": 3.14, # Double value.
+ "floatValue": 3.14, # Float value.
+ "intValue": "A String", # Integer value.
+ "stringList": { # Represents a list of strings. # List of string values.
+ "values": [ # The string values.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String value.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="query_next">query_next()</code>
+ <pre>Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/gmailpostmastertools_v2.domains.html b/docs/dyn/gmailpostmastertools_v2.domains.html
new file mode 100644
index 0000000..c789825
--- /dev/null
+++ b/docs/dyn/gmailpostmastertools_v2.domains.html
@@ -0,0 +1,234 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="gmailpostmastertools_v2.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v2.domains.html">domains</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="gmailpostmastertools_v2.domains.domainStats.html">domainStats()</a></code>
+</p>
+<p class="firstline">Returns the domainStats Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.</p>
+<p class="toc_element">
+ <code><a href="#getComplianceStatus">getComplianceStatus(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.</p>
+<p class="toc_element">
+ <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next()</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.
+
+Args:
+ name: string, Required. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com). (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Information about a domain registered by the user.
+ "createTime": "A String", # Output only. Immutable. The timestamp at which the domain was added to the user's account.
+ "lastVerifyTime": "A String", # The timestamp at which the domain was last verified by the user.
+ "name": "A String", # Identifier. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
+ "permission": "A String", # Output only. User's permission of this domain.
+ "verificationState": "A String", # Output only. Information about a user's verification history and properties for the domain.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getComplianceStatus">getComplianceStatus(name, x__xgafv=None)</code>
+ <pre>Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.
+
+Args:
+ name: string, Required. The resource name of the domain's compliance status to retrieve. Format: `domains/{domain_id}/complianceStatus`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Compliance status for a domain.
+ "complianceData": { # Compliance data for a given domain. # Compliance data for the registrable domain part of the domain in `name`. For example, if `name` is `domains/example.com/complianceStatus`, this field contains compliance data for `example.com`.
+ "domainId": "A String", # Domain that this data is for.
+ "honorUnsubscribeVerdict": { # Compliance verdict for whether a sender meets the unsubscribe honoring compliance requirement. # Unsubscribe honoring compliance verdict.
+ "reason": "A String", # The specific reason for the compliance verdict. Must be empty if the status is compliant.
+ "status": { # The status of a sender compliance requirement. # The compliance status.
+ "status": "A String", # Output only. The compliance status.
+ },
+ },
+ "oneClickUnsubscribeVerdict": { # Compliance verdict for whether a sender meets the one-click unsubscribe compliance requirement. # One-click unsubscribe compliance verdict.
+ "reason": "A String", # The specific reason for the compliance verdict. Must be empty if the status is compliant.
+ "status": { # The status of a sender compliance requirement. # The compliance status.
+ "status": "A String", # Output only. The compliance status.
+ },
+ },
+ "rowData": [ # Data for each of the rows of the table. Each message contains all the data that backs a single row.
+ { # Data for a single row of the compliance status table.
+ "requirement": "A String", # The compliance requirement.
+ "status": { # The status of a sender compliance requirement. # The compliance status for the requirement.
+ "status": "A String", # Output only. The compliance status.
+ },
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The resource name of the domain's compliance status. Format: `domains/{domain_id}/complianceStatus`.
+ "subdomainComplianceData": { # Compliance data for a given domain. # Compliance data calculated specifically for the subdomain in `name`. This field is only populated if the domain in `name` is a subdomain that differs from its registrable domain (e.g., `sub.example.com`), and if compliance data is available for that specific subdomain.
+ "domainId": "A String", # Domain that this data is for.
+ "honorUnsubscribeVerdict": { # Compliance verdict for whether a sender meets the unsubscribe honoring compliance requirement. # Unsubscribe honoring compliance verdict.
+ "reason": "A String", # The specific reason for the compliance verdict. Must be empty if the status is compliant.
+ "status": { # The status of a sender compliance requirement. # The compliance status.
+ "status": "A String", # Output only. The compliance status.
+ },
+ },
+ "oneClickUnsubscribeVerdict": { # Compliance verdict for whether a sender meets the one-click unsubscribe compliance requirement. # One-click unsubscribe compliance verdict.
+ "reason": "A String", # The specific reason for the compliance verdict. Must be empty if the status is compliant.
+ "status": { # The status of a sender compliance requirement. # The compliance status.
+ "status": "A String", # Output only. The compliance status.
+ },
+ },
+ "rowData": [ # Data for each of the rows of the table. Each message contains all the data that backs a single row.
+ { # Data for a single row of the compliance status table.
+ "requirement": "A String", # The compliance requirement.
+ "status": { # The status of a sender compliance requirement. # The compliance status for the requirement.
+ "status": "A String", # Output only. The compliance status.
+ },
+ },
+ ],
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.
+
+Args:
+ pageSize: integer, Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200.
+ pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListDomains.
+ "domains": [ # The domains that have been registered by the user.
+ { # Information about a domain registered by the user.
+ "createTime": "A String", # Output only. Immutable. The timestamp at which the domain was added to the user's account.
+ "lastVerifyTime": "A String", # The timestamp at which the domain was last verified by the user.
+ "name": "A String", # Identifier. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
+ "permission": "A String", # Output only. User's permission of this domain.
+ "verificationState": "A String", # Output only. Information about a user's verification history and properties for the domain.
+ },
+ ],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next()</code>
+ <pre>Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/gmailpostmastertools_v2.html b/docs/dyn/gmailpostmastertools_v2.html
new file mode 100644
index 0000000..f5777c9
--- /dev/null
+++ b/docs/dyn/gmailpostmastertools_v2.html
@@ -0,0 +1,116 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="gmailpostmastertools_v2.html">Gmail Postmaster Tools API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="gmailpostmastertools_v2.domainStats.html">domainStats()</a></code>
+</p>
+<p class="firstline">Returns the domainStats Resource.</p>
+
+<p class="toc_element">
+ <code><a href="gmailpostmastertools_v2.domains.html">domains()</a></code>
+</p>
+<p class="firstline">Returns the domains Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
+<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="new_batch_http_request">new_batch_http_request()</code>
+ <pre>Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html b/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html
index ba855d7..8a6d382 100644
--- a/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html
+++ b/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html
@@ -128,7 +128,7 @@
},
"newSpotInstances": { # When set in a ComputeResourceConfig, indicates that [spot VM](https://cloud.google.com/compute/docs/instances/spot) instances should be created. # Optional. Immutable. If set, indicates that this resource should use spot VMs.
"machineType": "A String", # Required. Immutable. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`.
- "terminationAction": "A String", # Optional. Specifies the termination action of the instance
+ "terminationAction": "A String", # Optional. Termination action for the instance. If not specified, Compute Engine sets the termination action to DELETE.
"zone": "A String", # Required. Immutable. Name of the zone in which VM instances should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
},
@@ -184,15 +184,15 @@
"startupScript": "A String", # Optional. [Startup script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) to be run on each login node instance. Max 256KB. The script must complete within the system-defined default timeout of 5 minutes. For tasks that require more time, consider running them in the background using methods such as `&` or `nohup`.
"storageConfigs": [ # Optional. How storage resources should be mounted on each login node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
"zone": "A String", # Required. Name of the zone in which login nodes should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
- "nodeSets": [ # Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.
+ "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.
{ # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster.
- "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's [compute_resources](Cluster.compute_resources).
+ "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources.
"computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances.
"bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance
"sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB.
@@ -208,13 +208,13 @@
"staticNodeCount": "A String", # Optional. Number of nodes to be statically created for this nodeset. The cluster will attempt to ensure that at least this many nodes exist at all times.
"storageConfigs": [ # Optional. How storage resources should be mounted on each compute node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
},
],
- "partitions": [ # Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.
+ "partitions": [ # Optional. Configuration for the Slurm partitions in your cluster. Each partition can contain one or more nodesets, and you can submit separate jobs on each partition. If you don't specify at least one partition in your cluster, you can't submit jobs to the cluster.
{ # Configuration for Slurm partitions in the cluster. Partitions are groups of nodesets, and are how clients specify where their workloads should be run.
"id": "A String", # Required. ID of the partition, which is how users will identify it. Must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).
"nodeSetIds": [ # Required. IDs of the nodesets that make up this partition. Values must match SlurmNodeSet.id.
@@ -383,7 +383,7 @@
},
"newSpotInstances": { # When set in a ComputeResourceConfig, indicates that [spot VM](https://cloud.google.com/compute/docs/instances/spot) instances should be created. # Optional. Immutable. If set, indicates that this resource should use spot VMs.
"machineType": "A String", # Required. Immutable. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`.
- "terminationAction": "A String", # Optional. Specifies the termination action of the instance
+ "terminationAction": "A String", # Optional. Termination action for the instance. If not specified, Compute Engine sets the termination action to DELETE.
"zone": "A String", # Required. Immutable. Name of the zone in which VM instances should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
},
@@ -439,15 +439,15 @@
"startupScript": "A String", # Optional. [Startup script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) to be run on each login node instance. Max 256KB. The script must complete within the system-defined default timeout of 5 minutes. For tasks that require more time, consider running them in the background using methods such as `&` or `nohup`.
"storageConfigs": [ # Optional. How storage resources should be mounted on each login node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
"zone": "A String", # Required. Name of the zone in which login nodes should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
- "nodeSets": [ # Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.
+ "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.
{ # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster.
- "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's [compute_resources](Cluster.compute_resources).
+ "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources.
"computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances.
"bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance
"sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB.
@@ -463,13 +463,13 @@
"staticNodeCount": "A String", # Optional. Number of nodes to be statically created for this nodeset. The cluster will attempt to ensure that at least this many nodes exist at all times.
"storageConfigs": [ # Optional. How storage resources should be mounted on each compute node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
},
],
- "partitions": [ # Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.
+ "partitions": [ # Optional. Configuration for the Slurm partitions in your cluster. Each partition can contain one or more nodesets, and you can submit separate jobs on each partition. If you don't specify at least one partition in your cluster, you can't submit jobs to the cluster.
{ # Configuration for Slurm partitions in the cluster. Partitions are groups of nodesets, and are how clients specify where their workloads should be run.
"id": "A String", # Required. ID of the partition, which is how users will identify it. Must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).
"nodeSetIds": [ # Required. IDs of the nodesets that make up this partition. Values must match SlurmNodeSet.id.
@@ -578,7 +578,7 @@
},
"newSpotInstances": { # When set in a ComputeResourceConfig, indicates that [spot VM](https://cloud.google.com/compute/docs/instances/spot) instances should be created. # Optional. Immutable. If set, indicates that this resource should use spot VMs.
"machineType": "A String", # Required. Immutable. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`.
- "terminationAction": "A String", # Optional. Specifies the termination action of the instance
+ "terminationAction": "A String", # Optional. Termination action for the instance. If not specified, Compute Engine sets the termination action to DELETE.
"zone": "A String", # Required. Immutable. Name of the zone in which VM instances should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
},
@@ -634,15 +634,15 @@
"startupScript": "A String", # Optional. [Startup script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) to be run on each login node instance. Max 256KB. The script must complete within the system-defined default timeout of 5 minutes. For tasks that require more time, consider running them in the background using methods such as `&` or `nohup`.
"storageConfigs": [ # Optional. How storage resources should be mounted on each login node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
"zone": "A String", # Required. Name of the zone in which login nodes should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
- "nodeSets": [ # Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.
+ "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.
{ # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster.
- "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's [compute_resources](Cluster.compute_resources).
+ "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources.
"computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances.
"bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance
"sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB.
@@ -658,13 +658,13 @@
"staticNodeCount": "A String", # Optional. Number of nodes to be statically created for this nodeset. The cluster will attempt to ensure that at least this many nodes exist at all times.
"storageConfigs": [ # Optional. How storage resources should be mounted on each compute node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
},
],
- "partitions": [ # Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.
+ "partitions": [ # Optional. Configuration for the Slurm partitions in your cluster. Each partition can contain one or more nodesets, and you can submit separate jobs on each partition. If you don't specify at least one partition in your cluster, you can't submit jobs to the cluster.
{ # Configuration for Slurm partitions in the cluster. Partitions are groups of nodesets, and are how clients specify where their workloads should be run.
"id": "A String", # Required. ID of the partition, which is how users will identify it. Must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).
"nodeSetIds": [ # Required. IDs of the nodesets that make up this partition. Values must match SlurmNodeSet.id.
@@ -782,7 +782,7 @@
},
"newSpotInstances": { # When set in a ComputeResourceConfig, indicates that [spot VM](https://cloud.google.com/compute/docs/instances/spot) instances should be created. # Optional. Immutable. If set, indicates that this resource should use spot VMs.
"machineType": "A String", # Required. Immutable. Name of the Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-resource) to use, e.g. `n2-standard-2`.
- "terminationAction": "A String", # Optional. Specifies the termination action of the instance
+ "terminationAction": "A String", # Optional. Termination action for the instance. If not specified, Compute Engine sets the termination action to DELETE.
"zone": "A String", # Required. Immutable. Name of the zone in which VM instances should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
},
@@ -838,15 +838,15 @@
"startupScript": "A String", # Optional. [Startup script](https://cloud.google.com/compute/docs/instances/startup-scripts/linux) to be run on each login node instance. Max 256KB. The script must complete within the system-defined default timeout of 5 minutes. For tasks that require more time, consider running them in the background using methods such as `&` or `nohup`.
"storageConfigs": [ # Optional. How storage resources should be mounted on each login node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
"zone": "A String", # Required. Name of the zone in which login nodes should run, e.g., `us-central1-a`. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.
},
- "nodeSets": [ # Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.
+ "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.
{ # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster.
- "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's [compute_resources](Cluster.compute_resources).
+ "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources.
"computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances.
"bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance
"sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB.
@@ -862,13 +862,13 @@
"staticNodeCount": "A String", # Optional. Number of nodes to be statically created for this nodeset. The cluster will attempt to ensure that at least this many nodes exist at all times.
"storageConfigs": [ # Optional. How storage resources should be mounted on each compute node.
{ # Description of how a storage resource should be mounted on a VM instance.
- "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).
+ "id": "A String", # Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.
"localMount": "A String", # Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., `/mnt/share`).
},
],
},
],
- "partitions": [ # Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.
+ "partitions": [ # Optional. Configuration for the Slurm partitions in your cluster. Each partition can contain one or more nodesets, and you can submit separate jobs on each partition. If you don't specify at least one partition in your cluster, you can't submit jobs to the cluster.
{ # Configuration for Slurm partitions in the cluster. Partitions are groups of nodesets, and are how clients specify where their workloads should be run.
"id": "A String", # Required. ID of the partition, which is how users will identify it. Must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).
"nodeSetIds": [ # Required. IDs of the nodesets that make up this partition. Values must match SlurmNodeSet.id.
diff --git a/docs/dyn/hypercomputecluster_v1.projects.locations.html b/docs/dyn/hypercomputecluster_v1.projects.locations.html
index 86c0777..1ad4790 100644
--- a/docs/dyn/hypercomputecluster_v1.projects.locations.html
+++ b/docs/dyn/hypercomputecluster_v1.projects.locations.html
@@ -92,7 +92,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -131,7 +131,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.html b/docs/dyn/iam_v1.locations.workforcePools.providers.html
index 5365f8e..4a1146a 100644
--- a/docs/dyn/iam_v1.locations.workforcePools.providers.html
+++ b/docs/dyn/iam_v1.locations.workforcePools.providers.html
@@ -152,7 +152,7 @@
"filter": "A String", # Optional. The filter used to request specific records from the IdP. By default, all of the groups that are associated with a user are fetched. For Microsoft Entra ID, you can add `$search` query parameters using [Keyword Query Language] (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). To learn more about `$search` querying in Microsoft Entra ID, see [Use the `$search` query parameter] (https://learn.microsoft.com/en-us/graph/search-query-parameter). Additionally, Workforce Identity Federation automatically adds the following [`$filter` query parameters] (https://learn.microsoft.com/en-us/graph/filter-query-parameter), based on the value of `attributes_type`. Values passed to `filter` are converted to `$search` query parameters. Additional `$filter` query parameters cannot be added using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is applied.
},
},
- "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently, this configuration is only supported with OIDC protocol.
+ "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. Defines the configuration for the OAuth 2.0 client that is used to get the additional user attributes in a separate backchannel call to the identity provider. This should be used when users can't get the required claims in authentication credentials. Currently, the OAuth 2.0 protocol is the only supported authorization method for this backchannel call.
"attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
"clientId": "A String", # Required. The OAuth 2.0 client ID for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Required. The OAuth 2.0 client secret for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
@@ -295,7 +295,7 @@
"filter": "A String", # Optional. The filter used to request specific records from the IdP. By default, all of the groups that are associated with a user are fetched. For Microsoft Entra ID, you can add `$search` query parameters using [Keyword Query Language] (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). To learn more about `$search` querying in Microsoft Entra ID, see [Use the `$search` query parameter] (https://learn.microsoft.com/en-us/graph/search-query-parameter). Additionally, Workforce Identity Federation automatically adds the following [`$filter` query parameters] (https://learn.microsoft.com/en-us/graph/filter-query-parameter), based on the value of `attributes_type`. Values passed to `filter` are converted to `$search` query parameters. Additional `$filter` query parameters cannot be added using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is applied.
},
},
- "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently, this configuration is only supported with OIDC protocol.
+ "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. Defines the configuration for the OAuth 2.0 client that is used to get the additional user attributes in a separate backchannel call to the identity provider. This should be used when users can't get the required claims in authentication credentials. Currently, the OAuth 2.0 protocol is the only supported authorization method for this backchannel call.
"attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
"clientId": "A String", # Required. The OAuth 2.0 client ID for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Required. The OAuth 2.0 client secret for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
@@ -380,7 +380,7 @@
"filter": "A String", # Optional. The filter used to request specific records from the IdP. By default, all of the groups that are associated with a user are fetched. For Microsoft Entra ID, you can add `$search` query parameters using [Keyword Query Language] (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). To learn more about `$search` querying in Microsoft Entra ID, see [Use the `$search` query parameter] (https://learn.microsoft.com/en-us/graph/search-query-parameter). Additionally, Workforce Identity Federation automatically adds the following [`$filter` query parameters] (https://learn.microsoft.com/en-us/graph/filter-query-parameter), based on the value of `attributes_type`. Values passed to `filter` are converted to `$search` query parameters. Additional `$filter` query parameters cannot be added using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is applied.
},
},
- "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently, this configuration is only supported with OIDC protocol.
+ "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. Defines the configuration for the OAuth 2.0 client that is used to get the additional user attributes in a separate backchannel call to the identity provider. This should be used when users can't get the required claims in authentication credentials. Currently, the OAuth 2.0 protocol is the only supported authorization method for this backchannel call.
"attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
"clientId": "A String", # Required. The OAuth 2.0 client ID for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Required. The OAuth 2.0 client secret for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
@@ -470,7 +470,7 @@
"filter": "A String", # Optional. The filter used to request specific records from the IdP. By default, all of the groups that are associated with a user are fetched. For Microsoft Entra ID, you can add `$search` query parameters using [Keyword Query Language] (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). To learn more about `$search` querying in Microsoft Entra ID, see [Use the `$search` query parameter] (https://learn.microsoft.com/en-us/graph/search-query-parameter). Additionally, Workforce Identity Federation automatically adds the following [`$filter` query parameters] (https://learn.microsoft.com/en-us/graph/filter-query-parameter), based on the value of `attributes_type`. Values passed to `filter` are converted to `$search` query parameters. Additional `$filter` query parameters cannot be added using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is applied.
},
},
- "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently, this configuration is only supported with OIDC protocol.
+ "extraAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, for example, groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. Defines the configuration for the OAuth 2.0 client that is used to get the additional user attributes in a separate backchannel call to the identity provider. This should be used when users can't get the required claims in authentication credentials. Currently, the OAuth 2.0 protocol is the only supported authorization method for this backchannel call.
"attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
"clientId": "A String", # Required. The OAuth 2.0 client ID for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
"clientSecret": { # Representation of a client secret configured for the OIDC provider. # Required. The OAuth 2.0 client secret for retrieving extra attributes from the identity provider. Required to get the Access Token using client credentials grant flow.
diff --git a/docs/dyn/iap_v1.v1.html b/docs/dyn/iap_v1.v1.html
index 16154e1..8837a57 100644
--- a/docs/dyn/iap_v1.v1.html
+++ b/docs/dyn/iap_v1.v1.html
@@ -179,6 +179,9 @@
"A String",
],
"oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Optional. Settings to configure IAP's OAuth behavior.
+ "clientId": "A String", # Optional. OAuth 2.0 client ID used in the OAuth flow to generate an access token. If this field is set, you can skip obtaining the OAuth credentials in this step: https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console. However, this could allow for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
+ "clientSecret": "A String", # Optional. Input only. OAuth secret paired with client ID
+ "clientSecretSha256": "A String", # Output only. OAuth secret sha256 paired with client ID
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.
"programmaticClients": [ # Optional. List of client ids allowed to use IAP programmatically.
"A String",
@@ -383,6 +386,9 @@
"A String",
],
"oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Optional. Settings to configure IAP's OAuth behavior.
+ "clientId": "A String", # Optional. OAuth 2.0 client ID used in the OAuth flow to generate an access token. If this field is set, you can skip obtaining the OAuth credentials in this step: https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console. However, this could allow for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
+ "clientSecret": "A String", # Optional. Input only. OAuth secret paired with client ID
+ "clientSecretSha256": "A String", # Output only. OAuth secret sha256 paired with client ID
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.
"programmaticClients": [ # Optional. List of client ids allowed to use IAP programmatically.
"A String",
@@ -498,6 +504,9 @@
"A String",
],
"oauthSettings": { # Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. # Optional. Settings to configure IAP's OAuth behavior.
+ "clientId": "A String", # Optional. OAuth 2.0 client ID used in the OAuth flow to generate an access token. If this field is set, you can skip obtaining the OAuth credentials in this step: https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console. However, this could allow for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.
+ "clientSecret": "A String", # Optional. Input only. OAuth secret paired with client ID
+ "clientSecretSha256": "A String", # Output only. OAuth secret sha256 paired with client ID
"loginHint": "A String", # Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.
"programmaticClients": [ # Optional. List of client ids allowed to use IAP programmatically.
"A String",
diff --git a/docs/dyn/index.md b/docs/dyn/index.md
index a308e72..27c0753 100644
--- a/docs/dyn/index.md
+++ b/docs/dyn/index.md
@@ -724,6 +724,7 @@
## gmailpostmastertools
* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/gmailpostmastertools_v1.html)
* [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/gmailpostmastertools_v1beta1.html)
+* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/gmailpostmastertools_v2.html)
## groupsmigration
@@ -812,10 +813,6 @@
* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/licensing_v1.html)
-## lifesciences
-* [v2beta](http://googleapis.github.io/google-api-python-client/docs/dyn/lifesciences_v2beta.html)
-
-
## localservices
* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/localservices_v1.html)
diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.html b/docs/dyn/merchantapi_accounts_v1.accounts.html
index 66de1cf..66e7c26 100644
--- a/docs/dyn/merchantapi_accounts_v1.accounts.html
+++ b/docs/dyn/merchantapi_accounts_v1.accounts.html
@@ -218,7 +218,7 @@
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
- "service": [ # Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `product_management` services may be provided.
+ "service": [ # Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `products_management` services may be provided.
{ # Additional instructions to add account services during creation of the account.
"accountAggregation": { # `AccountAggregation` payload. # The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation.
},
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
index 575e67c..e12f9d9 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
@@ -218,7 +218,7 @@
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
- "service": [ # Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `product_management` services may be provided.
+ "service": [ # Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `products_management` services may be provided.
{ # Additional instructions to add account services during creation of the account.
"accountAggregation": { # `AccountAggregation` payload. # The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation.
},
diff --git a/docs/dyn/metastore_v1.projects.locations.html b/docs/dyn/metastore_v1.projects.locations.html
index a5314c8..e8b933e 100644
--- a/docs/dyn/metastore_v1.projects.locations.html
+++ b/docs/dyn/metastore_v1.projects.locations.html
@@ -97,7 +97,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -136,7 +136,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/metastore_v1alpha.projects.locations.html b/docs/dyn/metastore_v1alpha.projects.locations.html
index 2e0c460..0837f9e 100644
--- a/docs/dyn/metastore_v1alpha.projects.locations.html
+++ b/docs/dyn/metastore_v1alpha.projects.locations.html
@@ -97,7 +97,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -136,7 +136,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/metastore_v1beta.projects.locations.html b/docs/dyn/metastore_v1beta.projects.locations.html
index b0d5fac..0bca518 100644
--- a/docs/dyn/metastore_v1beta.projects.locations.html
+++ b/docs/dyn/metastore_v1beta.projects.locations.html
@@ -97,7 +97,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -136,7 +136,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html
index 38d064f..a92d742 100644
--- a/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html
+++ b/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html
@@ -123,6 +123,7 @@
"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
"threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration.
}
securityProfileGroupId: string, Required. Short name of the SecurityProfileGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile_group1".
@@ -218,6 +219,7 @@
"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
"threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration.
}</pre>
</div>
@@ -253,6 +255,7 @@
"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
"threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration.
},
],
}</pre>
@@ -294,6 +297,7 @@
"name": "A String", # Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.
"threatPreventionProfile": "A String", # Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": "A String", # Optional. Reference to a SecurityProfile with the UrlFiltering configuration.
}
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the SecurityProfileGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
diff --git a/docs/dyn/networksecurity_v1.organizations.locations.securityProfiles.html b/docs/dyn/networksecurity_v1.organizations.locations.securityProfiles.html
index 00dc5c8..82caacf 100644
--- a/docs/dyn/networksecurity_v1.organizations.locations.securityProfiles.html
+++ b/docs/dyn/networksecurity_v1.organizations.locations.securityProfiles.html
@@ -147,6 +147,17 @@
},
"type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile.
+ "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
+ { # A URL filter defines an action to take for some URL match.
+ "filteringAction": "A String", # Required. The action taken when this filter is applied.
+ "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
+ "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
+ "A String",
+ ],
+ },
+ ],
+ },
}
securityProfileId: string, Required. Short name of the SecurityProfile resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile1".
@@ -266,6 +277,17 @@
},
"type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile.
+ "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
+ { # A URL filter defines an action to take for some URL match.
+ "filteringAction": "A String", # Required. The action taken when this filter is applied.
+ "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
+ "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
+ "A String",
+ ],
+ },
+ ],
+ },
}</pre>
</div>
@@ -325,6 +347,17 @@
},
"type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile.
+ "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
+ { # A URL filter defines an action to take for some URL match.
+ "filteringAction": "A String", # Required. The action taken when this filter is applied.
+ "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
+ "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
+ "A String",
+ ],
+ },
+ ],
+ },
},
],
}</pre>
@@ -390,6 +423,17 @@
},
"type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
"updateTime": "A String", # Output only. Last resource update timestamp.
+ "urlFilteringProfile": { # UrlFilteringProfile defines filters based on URL. # The URL filtering configuration for the SecurityProfile.
+ "urlFilters": [ # Optional. The list of filtering configs in which each config defines an action to take for some URL match.
+ { # A URL filter defines an action to take for some URL match.
+ "filteringAction": "A String", # Required. The action taken when this filter is applied.
+ "priority": 42, # Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.
+ "urls": [ # Required. The list of strings that a URL must match with for this filter to be applied.
+ "A String",
+ ],
+ },
+ ],
+ },
}
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the SecurityProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
diff --git a/docs/dyn/networkservices_v1.projects.locations.html b/docs/dyn/networkservices_v1.projects.locations.html
index ba780f8..8f3474e 100644
--- a/docs/dyn/networkservices_v1.projects.locations.html
+++ b/docs/dyn/networkservices_v1.projects.locations.html
@@ -172,7 +172,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -211,7 +211,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html b/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html
index 1c3f27e..e631609 100644
--- a/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html
+++ b/docs/dyn/networkservices_v1.projects.locations.tlsRoutes.html
@@ -147,6 +147,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
@@ -266,6 +269,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}</pre>
</div>
@@ -327,6 +333,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
},
],
@@ -396,6 +405,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.html b/docs/dyn/networkservices_v1beta1.projects.locations.html
index 353da48..d3af920 100644
--- a/docs/dyn/networkservices_v1beta1.projects.locations.html
+++ b/docs/dyn/networkservices_v1beta1.projects.locations.html
@@ -162,7 +162,7 @@
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists information about the supported locations for this service.</p>
+<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -201,7 +201,7 @@
<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists information about the supported locations for this service.
+ <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.tlsRoutes.html b/docs/dyn/networkservices_v1beta1.projects.locations.tlsRoutes.html
index 427fd36..b99a737 100644
--- a/docs/dyn/networkservices_v1beta1.projects.locations.tlsRoutes.html
+++ b/docs/dyn/networkservices_v1beta1.projects.locations.tlsRoutes.html
@@ -147,6 +147,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
@@ -266,6 +269,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}</pre>
</div>
@@ -327,6 +333,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
},
],
@@ -396,6 +405,9 @@
},
],
"selfLink": "A String", # Output only. Server-defined URL of this resource
+ "targetProxies": [ # Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`
+ "A String",
+ ],
"updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html
index 3ec6890..1179f10 100644
--- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html
+++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html
@@ -140,6 +140,7 @@
{ # BaseImage describes a base image of a container image.
"layerCount": 42, # The number of layers that the base image is composed of.
"name": "A String", # The name of the base image.
+ "registry": "A String", # The registry in which the base image is from.
"repository": "A String", # The repository name in which the base image is from.
},
],
@@ -156,6 +157,7 @@
{ # BaseImage describes a base image of a container image.
"layerCount": 42, # The number of layers that the base image is composed of.
"name": "A String", # The name of the base image.
+ "registry": "A String", # The registry in which the base image is from.
"repository": "A String", # The repository name in which the base image is from.
},
],
diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html
index 4eef29d..e690190 100644
--- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html
+++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html
@@ -139,6 +139,7 @@
{ # BaseImage describes a base image of a container image.
"layerCount": 42, # The number of layers that the base image is composed of.
"name": "A String", # The name of the base image.
+ "registry": "A String", # The registry in which the base image is from.
"repository": "A String", # The repository name in which the base image is from.
},
],
@@ -155,6 +156,7 @@
{ # BaseImage describes a base image of a container image.
"layerCount": 42, # The number of layers that the base image is composed of.
"name": "A String", # The name of the base image.
+ "registry": "A String", # The registry in which the base image is from.
"repository": "A String", # The repository name in which the base image is from.
},
],
diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html
index 5daf0c5..89fe6ca 100644
--- a/docs/dyn/places_v1.places.html
+++ b/docs/dyn/places_v1.places.html
@@ -535,6 +535,10 @@
"reviewsUri": "A String", # A link to show reviews of this place on Google Maps.
"writeAReviewUri": "A String", # A link to write a review for this place on Google Maps.
},
+ "googleMapsTypeLabel": { # Localized variant of a text in a particular language. # The type label of the place on Google Maps, localized to the request language if applicable, for example, "Restaurant", "Cafe", "Airport", etc. The type label may be different from the primary type display name and may not be a supported type in [Places API Place Types table](https://developers.google.com/maps/documentation/places/web-service/place-types).
+ "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "text": "A String", # Localized string in the language corresponding to language_code below.
+ },
"googleMapsUri": "A String", # A URL providing more information about this place.
"iconBackgroundColor": "A String", # Background color for icon_mask in hex format, e.g. #909CE1.
"iconMaskBaseUri": "A String", # A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").
@@ -1146,6 +1150,10 @@
"reviewsUri": "A String", # A link to show reviews of this place on Google Maps.
"writeAReviewUri": "A String", # A link to write a review for this place on Google Maps.
},
+ "googleMapsTypeLabel": { # Localized variant of a text in a particular language. # The type label of the place on Google Maps, localized to the request language if applicable, for example, "Restaurant", "Cafe", "Airport", etc. The type label may be different from the primary type display name and may not be a supported type in [Places API Place Types table](https://developers.google.com/maps/documentation/places/web-service/place-types).
+ "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "text": "A String", # Localized string in the language corresponding to language_code below.
+ },
"googleMapsUri": "A String", # A URL providing more information about this place.
"iconBackgroundColor": "A String", # Background color for icon_mask in hex format, e.g. #909CE1.
"iconMaskBaseUri": "A String", # A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").
@@ -1897,6 +1905,10 @@
"reviewsUri": "A String", # A link to show reviews of this place on Google Maps.
"writeAReviewUri": "A String", # A link to write a review for this place on Google Maps.
},
+ "googleMapsTypeLabel": { # Localized variant of a text in a particular language. # The type label of the place on Google Maps, localized to the request language if applicable, for example, "Restaurant", "Cafe", "Airport", etc. The type label may be different from the primary type display name and may not be a supported type in [Places API Place Types table](https://developers.google.com/maps/documentation/places/web-service/place-types).
+ "languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "text": "A String", # Localized string in the language corresponding to language_code below.
+ },
"googleMapsUri": "A String", # A URL providing more information about this place.
"iconBackgroundColor": "A String", # Background color for icon_mask in hex format, e.g. #909CE1.
"iconMaskBaseUri": "A String", # A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").
diff --git a/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html
index fbb682e..2177501 100644
--- a/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html
@@ -135,9 +135,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -213,9 +210,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -287,9 +281,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -365,9 +356,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -459,9 +447,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -537,9 +522,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -612,9 +594,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -690,9 +669,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -768,9 +744,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -846,9 +819,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -924,9 +894,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1002,9 +969,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html
index 6068408..eead6ab 100644
--- a/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1.folders.locations.recommenders.recommendations.html
@@ -135,9 +135,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -213,9 +210,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -287,9 +281,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -365,9 +356,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -459,9 +447,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -537,9 +522,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -612,9 +594,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -690,9 +669,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -768,9 +744,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -846,9 +819,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -924,9 +894,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1002,9 +969,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html
index 756b034..9434f0b 100644
--- a/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1.organizations.locations.recommenders.recommendations.html
@@ -135,9 +135,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -213,9 +210,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -287,9 +281,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -365,9 +356,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -459,9 +447,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -537,9 +522,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -612,9 +594,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -690,9 +669,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -768,9 +744,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -846,9 +819,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -924,9 +894,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1002,9 +969,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html
index 1fad3c6..a9b88e2 100644
--- a/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html
@@ -135,9 +135,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -213,9 +210,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -287,9 +281,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -365,9 +356,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -459,9 +447,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -537,9 +522,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -612,9 +594,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -690,9 +669,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -768,9 +744,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -846,9 +819,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -924,9 +894,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1002,9 +969,6 @@
},
"duration": "A String", # Duration for which this cost applies.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html
index bfcb777..e5adc70 100644
--- a/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1beta1.billingAccounts.locations.recommenders.recommendations.html
@@ -136,9 +136,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -215,9 +212,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -290,9 +284,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -369,9 +360,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -464,9 +452,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -543,9 +528,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -619,9 +601,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -698,9 +677,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -777,9 +753,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -856,9 +829,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -935,9 +905,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1014,9 +981,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html
index b1970b8..970e6cb 100644
--- a/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1beta1.folders.locations.recommenders.recommendations.html
@@ -136,9 +136,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -215,9 +212,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -290,9 +284,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -369,9 +360,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -464,9 +452,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -543,9 +528,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -619,9 +601,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -698,9 +677,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -777,9 +753,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -856,9 +829,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -935,9 +905,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1014,9 +981,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html
index 7b568ba..27715c4 100644
--- a/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1beta1.organizations.locations.recommenders.recommendations.html
@@ -136,9 +136,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -215,9 +212,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -290,9 +284,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -369,9 +360,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -464,9 +452,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -543,9 +528,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -619,9 +601,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -698,9 +677,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -777,9 +753,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -856,9 +829,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -935,9 +905,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1014,9 +981,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html
index ec31a64..ba38e80 100644
--- a/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html
+++ b/docs/dyn/recommender_v1beta1.projects.locations.recommenders.recommendations.html
@@ -136,9 +136,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -215,9 +212,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -290,9 +284,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -369,9 +360,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -464,9 +452,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -543,9 +528,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -619,9 +601,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -698,9 +677,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -777,9 +753,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -856,9 +829,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -935,9 +905,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
@@ -1014,9 +981,6 @@
"duration": "A String", # Duration for which this cost applies.
"pricingType": "A String", # How the cost is calculated.
},
- "impactComponents": [ # If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.
- # Object with schema name: GoogleCloudRecommenderV1beta1Impact
- ],
"reliabilityProjection": { # Contains information on the impact of a reliability recommendation. # Use with CategoryType.RELIABILITY
"details": { # Per-recommender projection.
"a_key": "", # Properties of the object.
diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html
index 417348b..e5a4405 100644
--- a/docs/dyn/redis_v1.projects.locations.clusters.html
+++ b/docs/dyn/redis_v1.projects.locations.clusters.html
@@ -331,8 +331,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
@@ -602,8 +605,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
@@ -839,8 +845,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
@@ -1059,8 +1068,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
diff --git a/docs/dyn/redis_v1.projects.locations.html b/docs/dyn/redis_v1.projects.locations.html
index 5031c9b..3184579 100644
--- a/docs/dyn/redis_v1.projects.locations.html
+++ b/docs/dyn/redis_v1.projects.locations.html
@@ -101,6 +101,9 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
+ <code><a href="#getSharedRegionalCertificateAuthority">getSharedRegionalCertificateAuthority(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the details of regional certificate authority information for Redis cluster.</p>
+<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
@@ -140,6 +143,34 @@
</div>
<div class="method">
+ <code class="details" id="getSharedRegionalCertificateAuthority">getSharedRegionalCertificateAuthority(name, x__xgafv=None)</code>
+ <pre>Gets the details of regional certificate authority information for Redis cluster.
+
+Args:
+ name: string, Required. Regional certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority` where `location_id` refers to a Google Cloud region. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Shared regional certificate authority
+ "managedServerCa": { # CA certificate chains for redis managed server authentication. # CA certificate chains for redis managed server authentication.
+ "caCerts": [ # The PEM encoded CA certificate chains for redis managed server authentication
+ { # The certificates that form the CA chain, from leaf to root order.
+ "certificates": [ # The certificates that form the CA chain, from leaf to root order.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "name": "A String", # Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project}/locations/{location}/sharedRegionalCertificateAuthority`
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html
index 577e068..3074663 100644
--- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html
+++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html
@@ -331,8 +331,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
@@ -602,8 +605,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
@@ -839,8 +845,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
@@ -1059,8 +1068,11 @@
"a_key": "A String",
},
"replicaCount": 42, # Optional. The number of replica nodes per shard.
+ "rotateServerCertificate": True or False, # Optional. Input only. Rotate the server certificates.
"satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
"satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+ "serverCaMode": "A String", # Optional. Server CA mode for the cluster.
+ "serverCaPool": "A String", # Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
"shardCount": 42, # Optional. Number of shards for the Redis cluster.
"simulateMaintenanceEvent": True or False, # Optional. Input only. Simulate a maintenance event.
"sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
diff --git a/docs/dyn/redis_v1beta1.projects.locations.html b/docs/dyn/redis_v1beta1.projects.locations.html
index 17fcf5e..3602442 100644
--- a/docs/dyn/redis_v1beta1.projects.locations.html
+++ b/docs/dyn/redis_v1beta1.projects.locations.html
@@ -101,6 +101,9 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a location.</p>
<p class="toc_element">
+ <code><a href="#getSharedRegionalCertificateAuthority">getSharedRegionalCertificateAuthority(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the details of regional certificate authority information for Redis cluster.</p>
+<p class="toc_element">
<code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p>
<p class="toc_element">
@@ -140,6 +143,34 @@
</div>
<div class="method">
+ <code class="details" id="getSharedRegionalCertificateAuthority">getSharedRegionalCertificateAuthority(name, x__xgafv=None)</code>
+ <pre>Gets the details of regional certificate authority information for Redis cluster.
+
+Args:
+ name: string, Required. Regional certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority` where `location_id` refers to a Google Cloud region. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Shared regional certificate authority
+ "managedServerCa": { # CA certificate chains for redis managed server authentication. # CA certificate chains for redis managed server authentication.
+ "caCerts": [ # The PEM encoded CA certificate chains for redis managed server authentication
+ { # The certificates that form the CA chain, from leaf to root order.
+ "certificates": [ # The certificates that form the CA chain, from leaf to root order.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "name": "A String", # Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project}/locations/{location}/sharedRegionalCertificateAuthority`
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html
index bdb7425..5461ff7 100644
--- a/docs/dyn/run_v1.namespaces.configurations.html
+++ b/docs/dyn/run_v1.namespaces.configurations.html
@@ -174,7 +174,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -528,7 +528,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
diff --git a/docs/dyn/run_v1.namespaces.instances.html b/docs/dyn/run_v1.namespaces.instances.html
index 4ed6792..e2a2741 100644
--- a/docs/dyn/run_v1.namespaces.instances.html
+++ b/docs/dyn/run_v1.namespaces.instances.html
@@ -331,6 +331,7 @@
"a_key": "A String",
},
"serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
{ # Volume represents a named volume in a container.
"configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
@@ -625,6 +626,7 @@
"a_key": "A String",
},
"serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
{ # Volume represents a named volume in a container.
"configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
@@ -970,6 +972,7 @@
"a_key": "A String",
},
"serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
{ # Volume represents a named volume in a container.
"configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
@@ -1281,6 +1284,7 @@
"a_key": "A String",
},
"serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
{ # Volume represents a named volume in a container.
"configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
@@ -1599,6 +1603,7 @@
"a_key": "A String",
},
"serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
{ # Volume represents a named volume in a container.
"configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
@@ -1906,6 +1911,7 @@
"a_key": "A String",
},
"serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
{ # Volume represents a named volume in a container.
"configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html
index 754a42a..9e4e989 100644
--- a/docs/dyn/run_v1.namespaces.revisions.html
+++ b/docs/dyn/run_v1.namespaces.revisions.html
@@ -151,7 +151,7 @@
Returns:
An object of the form:
- { # Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision
+ { # Revision is an immutable snapshot of code and configuration. A revision references one or more container images. Revisions are created by updates to a Service.
"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
"kind": "A String", # The kind of this resource, in this case "Revision".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations.
@@ -188,7 +188,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -471,7 +471,7 @@
{ # ListRevisionsResponse is a list of Revision resources.
"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
"items": [ # List of Revisions.
- { # Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision
+ { # Revision is an immutable snapshot of code and configuration. A revision references one or more container images. Revisions are created by updates to a Service.
"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
"kind": "A String", # The kind of this resource, in this case "Revision".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations.
@@ -508,7 +508,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html
index 3e69482..800b6e5 100644
--- a/docs/dyn/run_v1.namespaces.services.html
+++ b/docs/dyn/run_v1.namespaces.services.html
@@ -178,7 +178,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -540,7 +540,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -953,7 +953,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -1331,7 +1331,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -1705,7 +1705,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -2067,7 +2067,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
diff --git a/docs/dyn/run_v1.namespaces.workerpools.html b/docs/dyn/run_v1.namespaces.workerpools.html
index ad079cd..8e9b742 100644
--- a/docs/dyn/run_v1.namespaces.workerpools.html
+++ b/docs/dyn/run_v1.namespaces.workerpools.html
@@ -185,7 +185,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -537,7 +537,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -937,7 +937,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -1301,7 +1301,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -1665,7 +1665,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -2017,7 +2017,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html
index e0eec54..af9f4b3 100644
--- a/docs/dyn/run_v1.projects.locations.configurations.html
+++ b/docs/dyn/run_v1.projects.locations.configurations.html
@@ -174,7 +174,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -528,7 +528,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html
index 464a178..2e5746e 100644
--- a/docs/dyn/run_v1.projects.locations.revisions.html
+++ b/docs/dyn/run_v1.projects.locations.revisions.html
@@ -151,7 +151,7 @@
Returns:
An object of the form:
- { # Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision
+ { # Revision is an immutable snapshot of code and configuration. A revision references one or more container images. Revisions are created by updates to a Service.
"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
"kind": "A String", # The kind of this resource, in this case "Revision".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations.
@@ -188,7 +188,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -471,7 +471,7 @@
{ # ListRevisionsResponse is a list of Revision resources.
"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
"items": [ # List of Revisions.
- { # Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision
+ { # Revision is an immutable snapshot of code and configuration. A revision references one or more container images. Revisions are created by updates to a Service.
"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1".
"kind": "A String", # The kind of this resource, in this case "Revision".
"metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations.
@@ -508,7 +508,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html
index 79b8896..5990d95 100644
--- a/docs/dyn/run_v1.projects.locations.services.html
+++ b/docs/dyn/run_v1.projects.locations.services.html
@@ -187,7 +187,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -549,7 +549,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -962,7 +962,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -1388,7 +1388,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -1762,7 +1762,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
@@ -2124,7 +2124,7 @@
},
"spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client).
"containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.
+ "containers": [ # Required. Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html
index 10bc985..14541c6 100644
--- a/docs/dyn/run_v2.projects.locations.instances.html
+++ b/docs/dyn/run_v2.projects.locations.instances.html
@@ -309,6 +309,7 @@
"state": "A String", # State of the condition.
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
"updateTime": "A String", # Output only. The last-modified time.
"urls": [ # Output only. All URLs serving traffic for this Instance.
@@ -644,6 +645,7 @@
"state": "A String", # State of the condition.
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
"updateTime": "A String", # Output only. The last-modified time.
"urls": [ # Output only. All URLs serving traffic for this Instance.
@@ -917,6 +919,7 @@
"state": "A String", # State of the condition.
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
+ "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
"uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
"updateTime": "A String", # Output only. The last-modified time.
"urls": [ # Output only. All URLs serving traffic for this Instance.
diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html
index e9ce9ec..2a5e6ac 100644
--- a/docs/dyn/run_v2.projects.locations.services.html
+++ b/docs/dyn/run_v2.projects.locations.services.html
@@ -347,6 +347,8 @@
},
"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
"scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
@@ -748,6 +750,8 @@
},
"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
"scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
@@ -1136,6 +1140,8 @@
},
"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
"scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
@@ -1484,6 +1490,8 @@
},
"revision": "A String", # Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
"scaling": { # Settings for revision-level scaling settings. # Optional. Scaling settings for this Revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html
index ab4d5cd..ea0cf8d 100644
--- a/docs/dyn/run_v2.projects.locations.services.revisions.html
+++ b/docs/dyn/run_v2.projects.locations.services.revisions.html
@@ -203,7 +203,7 @@
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
- "containers": [ # Holds the single container that defines the unit of execution for this Revision.
+ "containers": [ # Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
@@ -357,6 +357,8 @@
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
@@ -463,7 +465,7 @@
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
- "containers": [ # Holds the single container that defines the unit of execution for this Revision.
+ "containers": [ # Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
@@ -617,6 +619,8 @@
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html
index 19fb801..60f733d 100644
--- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html
+++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html
@@ -164,7 +164,7 @@
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
- "containers": [ # Holds the single container that defines the unit of execution for this Revision.
+ "containers": [ # Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
@@ -318,6 +318,8 @@
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
@@ -424,7 +426,7 @@
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
- "containers": [ # Holds the single container that defines the unit of execution for this Revision.
+ "containers": [ # Containers holds the list which define the units of execution for this Revision.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
@@ -578,6 +580,8 @@
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scaling": { # Settings for revision-level scaling settings. # Scaling settings for this revision.
+ "concurrencyUtilization": 3.14, # Optional. Determines a threshold for concurrency utilization before scaling begins.
+ "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins.
"maxInstanceCount": 42, # Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances
"minInstanceCount": 42, # Optional. Minimum number of serving instances that this resource should have.
},
diff --git a/docs/dyn/serviceconsumermanagement_v1.services.html b/docs/dyn/serviceconsumermanagement_v1.services.html
index daf735e..36dc1e7 100644
--- a/docs/dyn/serviceconsumermanagement_v1.services.html
+++ b/docs/dyn/serviceconsumermanagement_v1.services.html
@@ -100,7 +100,7 @@
Args:
parent: string, Required. Service for which search is performed. services/{service} {service} the name of a service, for example 'service.googleapis.com'. (required)
- pageSize: integer, Optional. The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If `page_size` isn't provided or the size provided is a number larger than 1000, it's automatically set to 1000.
+ pageSize: integer, Optional. The maximum number of results returned by this request. Currently, the default maximum is set to 256. If `page_size` <= 256, the request proceeds. Else, the request fails with an `TU_INVALID_PAGE_SIZE` error.
pageToken: string, Optional. The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of `nextPageToken` from the previous response.
query: string, Optional. Set a query `{expression}` for querying tenancy units. Your `{expression}` must be in the format: `field_name=literal_string`. The `field_name` is the name of the field you want to compare. Supported fields are `tenant_resources.tag` and `tenant_resources.resource`. For example, to search tenancy units that contain at least one tenant resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`. To search tenancy units that contain at least one tenant resource with a given resource name 'projects/123456', use the query `tenant_resources.resource=projects/123456`. Multiple expressions can be joined with `AND`s. Tenancy units must match all expressions to be included in the result set. For example, `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/solar_v1.dataLayers.html b/docs/dyn/solar_v1.dataLayers.html
index 911c97c..db65591 100644
--- a/docs/dyn/solar_v1.dataLayers.html
+++ b/docs/dyn/solar_v1.dataLayers.html
@@ -142,7 +142,7 @@
"imageryQuality": "A String", # The quality of the result's imagery.
"maskUrl": "A String", # The URL for the building mask image: one bit per pixel saying whether that pixel is considered to be part of a rooftop or not.
"monthlyFluxUrl": "A String", # The URL for the monthly flux map (sunlight on roofs, broken down by month) of the region. Values are kWh/kW/year. The GeoTIFF pointed to by this URL will contain twelve bands, corresponding to January...December, in order.
- "rgbUrl": "A String", # The URL for an image of RGB data (aerial photo) of the region.
+ "rgbUrl": "A String", # The URL for an image of RGB data (aerial or satellite photo) of the region.
}</pre>
</div>
diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html
index 348c141..a3a32db 100644
--- a/docs/dyn/sqladmin_v1.instances.html
+++ b/docs/dyn/sqladmin_v1.instances.html
@@ -168,9 +168,6 @@
<code><a href="#restoreBackup">restoreBackup(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.</p>
<p class="toc_element">
- <code><a href="#restoreBackupMcp">restoreBackupMcp(targetProject, targetInstance, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Restores a backup of a Cloud SQL instance for Model Context Protocol (MCP) server.</p>
-<p class="toc_element">
<code><a href="#rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.</p>
<p class="toc_element">
@@ -1164,6 +1161,8 @@
"A String",
],
"destinationInstanceName": "A String", # Required. Name of the Cloud SQL instance to be created as a clone.
+ "destinationNetwork": "A String", # Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:`projects/my-network-project/global/networks/my-network`. This field is only required for cross-project cloning.
+ "destinationProject": "A String", # Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.
"kind": "A String", # This is always `sql#cloneContext`.
"pitrTimestampMs": "A String", # Reserved for future use.
"pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned.
@@ -6110,179 +6109,6 @@
</div>
<div class="method">
- <code class="details" id="restoreBackupMcp">restoreBackupMcp(targetProject, targetInstance, body=None, x__xgafv=None)</code>
- <pre>Restores a backup of a Cloud SQL instance for Model Context Protocol (MCP) server.
-
-Args:
- targetProject: string, Required. Project ID of the target project. (required)
- targetInstance: string, Required. Cloud SQL instance ID of the target. This does not include the project ID. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Instance restore backup request for MCP.
- "backupId": "A String", # Required. The identifier of the backup to restore. This will be one of the following: 1. An int64 containing a backup_run_id. 2. A backup name of the format 'projects/{project}/backups/{backup-uid}'. 3. A backupDR name of the format 'projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}'.
- "sourceInstance": "A String", # Optional. The Cloud SQL instance ID of the source instance containing the backup. Only necessary if the backup_id is a backup_run_id.
- "sourceProject": "A String", # Required. The project ID of the source instance containing the backup.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
- "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
- "duration": "A String", # Lease duration needed for SSRS setup.
- "reportDatabase": "A String", # The report database to be used for SSRS setup.
- "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
- "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
- },
- "apiWarning": { # An Admin API warning message. # An Admin API warning message.
- "code": "A String", # Code to uniquely identify the warning type.
- "message": "A String", # The warning message.
- "region": "A String", # The region name for REGION_UNREACHABLE warning.
- },
- "backupContext": { # Backup context. # The context for backup operation, if applicable.
- "backupId": "A String", # The identifier of the backup.
- "kind": "A String", # This is always `sql#backupContext`.
- "name": "A String", # The name of the backup. Format: projects/{project}/backups/{backup}
- },
- "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
- "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
- "errors": [ # The list of errors encountered while processing this operation.
- { # Database instance operation error.
- "code": "A String", # Identifies the specific error that occurred.
- "kind": "A String", # This is always `sql#operationError`.
- "message": "A String", # Additional information about the error encountered.
- },
- ],
- "kind": "A String", # This is always `sql#operationErrors`.
- },
- "exportContext": { # Database instance export context. # The context for export operation, if applicable.
- "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
- "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
- "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
- "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
- "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
- "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
- "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
- "striped": True or False, # Whether or not the export should be striped.
- },
- "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
- "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
- "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
- "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
- "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
- "selectQuery": "A String", # The select query used to extract the data.
- },
- "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
- "A String",
- ],
- "fileType": "A String", # The file type for the specified uri.
- "kind": "A String", # This is always `sql#exportContext`.
- "offload": True or False, # Whether to perform a serverless export.
- "sqlExportOptions": { # Options for exporting data as SQL statements.
- "mysqlExportOptions": { # Options for exporting from MySQL.
- "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
- },
- "parallel": True or False, # Optional. Whether or not the export should be parallel.
- "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
- "clean": True or False, # Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation.
- "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
- },
- "schemaOnly": True or False, # Export only schemas.
- "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
- "A String",
- ],
- "threads": 42, # Optional. The number of threads to use for parallel export.
- },
- "tdeExportOptions": { # Optional. Export parameters specific to SQL Server TDE certificates
- "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the bucket. Applicable only for SQL Server instances.
- "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
- "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
- "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
- },
- "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
- },
- "importContext": { # Database instance import context. # The context for import operation, if applicable.
- "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
- "bakType": "A String", # Type of the bak content, FULL or DIFF
- "encryptionOptions": {
- "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
- "keepEncrypted": True or False, # Optional. Whether the imported file remains encrypted.
- "pvkPassword": "A String", # Password that encrypts the private key
- "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
- },
- "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option. Applies only to Cloud SQL for SQL Server.
- "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
- "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
- "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
- "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
- },
- "csvImportOptions": { # Options for importing data as CSV.
- "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
- "A String",
- ],
- "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
- "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
- "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
- "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
- "table": "A String", # The table to which CSV data is imported.
- },
- "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.
- "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
- "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
- "kind": "A String", # This is always `sql#importContext`.
- "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
- "parallel": True or False, # Optional. Whether or not the import should be parallel.
- "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
- "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
- "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
- },
- "threads": 42, # Optional. The number of threads to use for parallel import.
- },
- "tdeImportOptions": { # Optional. Import parameters specific to SQL Server TDE certificates
- "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
- "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
- "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
- "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
- },
- "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
- },
- "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
- "kind": "A String", # This is always `sql#operation`.
- "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
- "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
- "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
- "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
- "preCheckResponse": [ # Output only. The responses from the precheck operation.
- { # Structured PreCheckResponse containing message, type, and required actions.
- "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
- "A String",
- ],
- "message": "A String", # The message to be displayed to the user.
- "messageType": "A String", # The type of message whether it is an info, warning, or error.
- },
- ],
- "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
- },
- "selfLink": "A String", # The URI of this resource.
- "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
- "status": "A String", # The status of an operation.
- "subOperationType": { # The sub operation type based on the operation type. # Optional. The sub operation based on the operation type.
- "maintenanceType": "A String", # The type of maintenance to be performed on the instance.
- },
- "targetId": "A String", # Name of the resource on which this operation runs.
- "targetLink": "A String",
- "targetProject": "A String", # The project ID of the target instance related to this operation.
- "user": "A String", # The email address of the user who initiated this operation.
-}</pre>
-</div>
-
-<div class="method">
<code class="details" id="rotateServerCa">rotateServerCa(project, instance, body=None, x__xgafv=None)</code>
<pre>Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.
diff --git a/docs/dyn/sqladmin_v1.users.html b/docs/dyn/sqladmin_v1.users.html
index d40aae0..c7b9e07 100644
--- a/docs/dyn/sqladmin_v1.users.html
+++ b/docs/dyn/sqladmin_v1.users.html
@@ -90,7 +90,7 @@
<code><a href="#list">list(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Lists users in the specified Cloud SQL instance.</p>
<p class="toc_element">
- <code><a href="#update">update(project, instance, body=None, databaseRoles=None, host=None, name=None, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing user in a Cloud SQL instance.</p>
<h3>Method Details</h3>
<div class="method">
@@ -571,7 +571,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(project, instance, body=None, databaseRoles=None, host=None, name=None, x__xgafv=None)</code>
+ <code class="details" id="update">update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, x__xgafv=None)</code>
<pre>Updates an existing user in a Cloud SQL instance.
Args:
@@ -616,6 +616,7 @@
databaseRoles: string, Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request. (repeated)
host: string, Optional. Host of the user in the instance.
name: string, Name of the user in the instance.
+ revokeExistingRoles: boolean, Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index 618a5fe..36c4117 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -1161,6 +1161,8 @@
"A String",
],
"destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
+ "destinationNetwork": "A String", # Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:`projects/my-network-project/global/networks/my-network`. This field is only required for cross-project cloning.
+ "destinationProject": "A String", # Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.
"kind": "A String", # This is always `sql#cloneContext`.
"pitrTimestampMs": "A String", # Reserved for future use.
"pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned.
diff --git a/docs/dyn/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html
index bc334bd..d172d3b 100644
--- a/docs/dyn/sqladmin_v1beta4.users.html
+++ b/docs/dyn/sqladmin_v1beta4.users.html
@@ -616,7 +616,7 @@
databaseRoles: string, Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request. (repeated)
host: string, Optional. Host of the user in the instance.
name: string, Name of the user in the instance.
- revokeExistingRoles: boolean, Optional. revoke the existing roles granted to the user.
+ revokeExistingRoles: boolean, Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/storage_v1.folders.html b/docs/dyn/storage_v1.folders.html
index 621dc68..4c836f1 100644
--- a/docs/dyn/storage_v1.folders.html
+++ b/docs/dyn/storage_v1.folders.html
@@ -81,6 +81,9 @@
<code><a href="#delete">delete(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.</p>
<p class="toc_element">
+ <code><a href="#deleteRecursive">deleteRecursive(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
+<p class="firstline">Deletes a folder recursively. Only applicable to buckets with hierarchical namespace enabled.</p>
+<p class="toc_element">
<code><a href="#get">get(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.</p>
<p class="toc_element">
@@ -114,6 +117,42 @@
</div>
<div class="method">
+ <code class="details" id="deleteRecursive">deleteRecursive(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
+ <pre>Deletes a folder recursively. Only applicable to buckets with hierarchical namespace enabled.
+
+Args:
+ bucket: string, Name of the bucket in which the folder resides. (required)
+ folder: string, Name of a folder. (required)
+ ifMetagenerationMatch: string, If set, only deletes the folder if its metageneration matches this value.
+ ifMetagenerationNotMatch: string, If set, only deletes the folder if its metageneration does not match this value.
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is "false", it means the operation is still in progress. If "true", the operation is completed, and either "error" or "response" is available.
+ "error": { # The "Status" type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each "Status" message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English.
+ },
+ "kind": "storage#operation", # The kind of item this is. For operations, this is always storage#operation.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the "name" should be a resource name ending with "operations/{operationId}".
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as "Delete", the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type "XxxResponse", where "Xxx" is the original method name. For example, if the original method name is "TakeSnapshot()", the inferred response type is "TakeSnapshotResponse".
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "selfLink": "A String", # The link to this long running operation.
+}</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(bucket, folder, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</code>
<pre>Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.
diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html
index 83cb2f7..8011615 100644
--- a/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html
+++ b/docs/dyn/storagebatchoperations_v1.projects.locations.jobs.html
@@ -183,6 +183,7 @@
],
},
],
+ "isMultiBucketJob": True or False, # Output only. If true, this Job operates on multiple buckets. Multibucket jobs are subject to different quota limits than single-bucket jobs.
"loggingConfig": { # Specifies the Cloud Logging behavior. # Optional. Logging configuration.
"logActionStates": [ # Required. States in which Action are logged.If empty, no logs are generated.
"A String",
@@ -326,6 +327,7 @@
],
},
],
+ "isMultiBucketJob": True or False, # Output only. If true, this Job operates on multiple buckets. Multibucket jobs are subject to different quota limits than single-bucket jobs.
"loggingConfig": { # Specifies the Cloud Logging behavior. # Optional. Logging configuration.
"logActionStates": [ # Required. States in which Action are logged.If empty, no logs are generated.
"A String",
@@ -425,6 +427,7 @@
],
},
],
+ "isMultiBucketJob": True or False, # Output only. If true, this Job operates on multiple buckets. Multibucket jobs are subject to different quota limits than single-bucket jobs.
"loggingConfig": { # Specifies the Cloud Logging behavior. # Optional. Logging configuration.
"logActionStates": [ # Required. States in which Action are logged.If empty, no logs are generated.
"A String",
diff --git a/docs/dyn/walletobjects_v1.eventticketclass.html b/docs/dyn/walletobjects_v1.eventticketclass.html
index e5febe5..c825a85 100644
--- a/docs/dyn/walletobjects_v1.eventticketclass.html
+++ b/docs/dyn/walletobjects_v1.eventticketclass.html
@@ -1154,7 +1154,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2364,7 +2364,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3562,7 +3562,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4759,7 +4759,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5972,7 +5972,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7173,7 +7173,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8370,7 +8370,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9569,7 +9569,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10766,7 +10766,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.eventticketobject.html b/docs/dyn/walletobjects_v1.eventticketobject.html
index 032f986..4e3e932 100644
--- a/docs/dyn/walletobjects_v1.eventticketobject.html
+++ b/docs/dyn/walletobjects_v1.eventticketobject.html
@@ -1480,7 +1480,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2088,7 +2088,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3511,7 +3511,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4119,7 +4119,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5530,7 +5530,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6138,7 +6138,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7548,7 +7548,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8156,7 +8156,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9582,7 +9582,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10190,7 +10190,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -11623,7 +11623,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12231,7 +12231,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -13643,7 +13643,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14251,7 +14251,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -15661,7 +15661,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16269,7 +16269,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -17681,7 +17681,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -18289,7 +18289,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -19699,7 +19699,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -20307,7 +20307,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.flightclass.html b/docs/dyn/walletobjects_v1.flightclass.html
index 81b34db..c688eb4 100644
--- a/docs/dyn/walletobjects_v1.flightclass.html
+++ b/docs/dyn/walletobjects_v1.flightclass.html
@@ -1312,7 +1312,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2609,7 +2609,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3894,7 +3894,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5178,7 +5178,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6478,7 +6478,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7766,7 +7766,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9050,7 +9050,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10336,7 +10336,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -11620,7 +11620,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.flightobject.html b/docs/dyn/walletobjects_v1.flightobject.html
index 0967ee6..a7a37fd 100644
--- a/docs/dyn/walletobjects_v1.flightobject.html
+++ b/docs/dyn/walletobjects_v1.flightobject.html
@@ -1697,7 +1697,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2205,7 +2205,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3848,7 +3848,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4356,7 +4356,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5987,7 +5987,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6495,7 +6495,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8125,7 +8125,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8633,7 +8633,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10279,7 +10279,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10787,7 +10787,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12421,7 +12421,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12929,7 +12929,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14559,7 +14559,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -15067,7 +15067,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16699,7 +16699,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -17207,7 +17207,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -18837,7 +18837,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -19345,7 +19345,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.genericclass.html b/docs/dyn/walletobjects_v1.genericclass.html
index 21df093..3f64270 100644
--- a/docs/dyn/walletobjects_v1.genericclass.html
+++ b/docs/dyn/walletobjects_v1.genericclass.html
@@ -849,7 +849,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -1644,7 +1644,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2427,7 +2427,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3209,7 +3209,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4007,7 +4007,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4793,7 +4793,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5575,7 +5575,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6359,7 +6359,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7141,7 +7141,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.genericobject.html b/docs/dyn/walletobjects_v1.genericobject.html
index 641a00e..31b7773 100644
--- a/docs/dyn/walletobjects_v1.genericobject.html
+++ b/docs/dyn/walletobjects_v1.genericobject.html
@@ -843,7 +843,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -1669,7 +1669,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2483,7 +2483,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3296,7 +3296,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4125,7 +4125,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4942,7 +4942,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5755,7 +5755,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6570,7 +6570,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7383,7 +7383,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.giftcardclass.html b/docs/dyn/walletobjects_v1.giftcardclass.html
index 3ca673c..2c9e7e5 100644
--- a/docs/dyn/walletobjects_v1.giftcardclass.html
+++ b/docs/dyn/walletobjects_v1.giftcardclass.html
@@ -1086,7 +1086,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2195,7 +2195,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3292,7 +3292,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4388,7 +4388,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5500,7 +5500,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6600,7 +6600,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7696,7 +7696,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8794,7 +8794,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9890,7 +9890,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.giftcardobject.html b/docs/dyn/walletobjects_v1.giftcardobject.html
index 9d80c4f..a44841d 100644
--- a/docs/dyn/walletobjects_v1.giftcardobject.html
+++ b/docs/dyn/walletobjects_v1.giftcardobject.html
@@ -1418,7 +1418,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -1902,7 +1902,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3266,7 +3266,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3750,7 +3750,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5102,7 +5102,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5586,7 +5586,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6937,7 +6937,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7421,7 +7421,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8788,7 +8788,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9272,7 +9272,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10627,7 +10627,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -11111,7 +11111,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12462,7 +12462,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12946,7 +12946,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14299,7 +14299,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14783,7 +14783,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16134,7 +16134,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16618,7 +16618,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.jwt.html b/docs/dyn/walletobjects_v1.jwt.html
index 9a33417..e03fe88 100644
--- a/docs/dyn/walletobjects_v1.jwt.html
+++ b/docs/dyn/walletobjects_v1.jwt.html
@@ -1100,7 +1100,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2613,7 +2613,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3221,7 +3221,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4459,7 +4459,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6121,7 +6121,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6629,7 +6629,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7404,7 +7404,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8173,7 +8173,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9222,7 +9222,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10643,7 +10643,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -11127,7 +11127,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12238,7 +12238,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -13751,7 +13751,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14292,7 +14292,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -15341,7 +15341,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16790,7 +16790,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -17272,7 +17272,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -18525,7 +18525,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -20219,7 +20219,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -21188,7 +21188,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.loyaltyclass.html b/docs/dyn/walletobjects_v1.loyaltyclass.html
index 4b7e66a..0b9509d 100644
--- a/docs/dyn/walletobjects_v1.loyaltyclass.html
+++ b/docs/dyn/walletobjects_v1.loyaltyclass.html
@@ -1185,7 +1185,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2393,7 +2393,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3589,7 +3589,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4784,7 +4784,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5995,7 +5995,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7194,7 +7194,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8389,7 +8389,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9586,7 +9586,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10781,7 +10781,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.loyaltyobject.html b/docs/dyn/walletobjects_v1.loyaltyobject.html
index cb4e922..7b169c0 100644
--- a/docs/dyn/walletobjects_v1.loyaltyobject.html
+++ b/docs/dyn/walletobjects_v1.loyaltyobject.html
@@ -1513,7 +1513,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2054,7 +2054,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3510,7 +3510,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4051,7 +4051,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5495,7 +5495,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6036,7 +6036,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7479,7 +7479,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8020,7 +8020,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9479,7 +9479,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10020,7 +10020,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -11486,7 +11486,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12027,7 +12027,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -13472,7 +13472,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14013,7 +14013,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -15456,7 +15456,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -15997,7 +15997,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -17442,7 +17442,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -17983,7 +17983,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -19426,7 +19426,7 @@
},
},
],
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -19967,7 +19967,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.offerclass.html b/docs/dyn/walletobjects_v1.offerclass.html
index 59d94ae..8c46ae8 100644
--- a/docs/dyn/walletobjects_v1.offerclass.html
+++ b/docs/dyn/walletobjects_v1.offerclass.html
@@ -1123,7 +1123,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2269,7 +2269,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3403,7 +3403,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4536,7 +4536,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5685,7 +5685,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6822,7 +6822,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7955,7 +7955,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9090,7 +9090,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10223,7 +10223,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.offerobject.html b/docs/dyn/walletobjects_v1.offerobject.html
index a6fe645..ed092a1 100644
--- a/docs/dyn/walletobjects_v1.offerobject.html
+++ b/docs/dyn/walletobjects_v1.offerobject.html
@@ -1446,7 +1446,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -1928,7 +1928,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3320,7 +3320,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -3802,7 +3802,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5182,7 +5182,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5664,7 +5664,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7043,7 +7043,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7525,7 +7525,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8920,7 +8920,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9402,7 +9402,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10785,7 +10785,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -11267,7 +11267,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12646,7 +12646,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -13128,7 +13128,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14509,7 +14509,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14991,7 +14991,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16370,7 +16370,7 @@
"uri": "A String", # The location of the image. URIs must have a scheme.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -16852,7 +16852,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.transitclass.html b/docs/dyn/walletobjects_v1.transitclass.html
index 9c3029f..1bdd84e 100644
--- a/docs/dyn/walletobjects_v1.transitclass.html
+++ b/docs/dyn/walletobjects_v1.transitclass.html
@@ -1327,7 +1327,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2715,7 +2715,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4091,7 +4091,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5466,7 +5466,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6857,7 +6857,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -8236,7 +8236,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9611,7 +9611,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10988,7 +10988,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12363,7 +12363,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/walletobjects_v1.transitobject.html b/docs/dyn/walletobjects_v1.transitobject.html
index 7181a39..8630788 100644
--- a/docs/dyn/walletobjects_v1.transitobject.html
+++ b/docs/dyn/walletobjects_v1.transitobject.html
@@ -1653,7 +1653,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -2622,7 +2622,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -4221,7 +4221,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -5190,7 +5190,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -6777,7 +6777,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -7746,7 +7746,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -9332,7 +9332,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -10301,7 +10301,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -11903,7 +11903,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -12872,7 +12872,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -14462,7 +14462,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -15431,7 +15431,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -17017,7 +17017,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -17986,7 +17986,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -19574,7 +19574,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -20543,7 +20543,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -22129,7 +22129,7 @@
],
},
"transitType": "A String", # Required. The type of transit this class represents, such as "bus".
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
@@ -23098,7 +23098,7 @@
"date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.
},
},
- "valueAddedModuleData": [ # Optional value added module data. Maximum of ten on the object.
+ "valueAddedModuleData": [ # Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.
{ # Data for Value Added module. Required fields are header and uri.
"body": { # Body to be displayed on the module. Character limit is 50 and longer strings will be truncated.
"defaultValue": { # Contains the string to be displayed if no appropriate translation is available.
diff --git a/docs/dyn/workloadmanager_v1.projects.locations.deployments.actuations.html b/docs/dyn/workloadmanager_v1.projects.locations.deployments.actuations.html
new file mode 100644
index 0000000..7c2b2e5
--- /dev/null
+++ b/docs/dyn/workloadmanager_v1.projects.locations.deployments.actuations.html
@@ -0,0 +1,312 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="workloadmanager_v1.html">Workload Manager API</a> . <a href="workloadmanager_v1.projects.html">projects</a> . <a href="workloadmanager_v1.projects.locations.html">locations</a> . <a href="workloadmanager_v1.projects.locations.deployments.html">deployments</a> . <a href="workloadmanager_v1.projects.locations.deployments.actuations.html">actuations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#create">create(parent, body=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new actuation for an existing Deployment.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a single Actuation</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets details of a single Actuation.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists Actuations in a given project, location and deployment.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next()</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="create">create(parent, body=None, requestId=None, x__xgafv=None)</code>
+ <pre>Creates a new actuation for an existing Deployment.
+
+Args:
+ parent: string, Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}' (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The Actuation object represents the bootstrap state and output results of deployed infrastructure and software.
+ "actuationOutput": { # Message for output of Actuation # Output only. [Output only] Actuation output
+ "actuateLogs": "A String", # A link to gcs file that store build logs
+ "ansibleError": "A String", # Output only. error message return from ansible.
+ "ansibleFailedTask": [ # Output only. failed task name return from ansible.
+ "A String",
+ ],
+ "blueprintId": "A String", # reference to Blueprint Controller deployment and revision resource
+ "cloudbuildId": "A String", # Cloud Build instance UUID associated with this revision, without any suffix or prefix
+ "errorCode": "A String", # Output only. Code describing any errors that may have occurred. If not specified, there is no error in actuation.
+ "errorLogs": "A String", # A link to actuation cloud build log.
+ "hasUserFacingErrorMsg": True or False, # Output only. whether the error message is user facing. If true, the error message will be shown in the UI.
+ "terraformError": "A String", # Output only. error message return from terraform.
+ "terraformTemplate": "A String", # reference to terraform template used
+ },
+ "deploymentOutput": [ # Output only. [Output only] Deployment output
+ { # Message for output of deployment resource
+ "name": "A String", # name of the resource
+ "type": "A String", # type of the resource
+ },
+ ],
+ "endTime": "A String", # Output only. [Output only] End time stamp
+ "name": "A String", # The name of actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}
+ "startTime": "A String", # Output only. [Output only] Start time stamp
+ "state": "A String", # Output only. [Output only] Actuation state
+}
+
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a single Actuation
+
+Args:
+ name: string, Required. The name of the book to delete. project/{project_id}/locations/{location_id}/deployments/{deployment_id}/actuations/{actuation_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets details of a single Actuation.
+
+Args:
+ name: string, Required. Name of the resource (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The Actuation object represents the bootstrap state and output results of deployed infrastructure and software.
+ "actuationOutput": { # Message for output of Actuation # Output only. [Output only] Actuation output
+ "actuateLogs": "A String", # A link to gcs file that store build logs
+ "ansibleError": "A String", # Output only. error message return from ansible.
+ "ansibleFailedTask": [ # Output only. failed task name return from ansible.
+ "A String",
+ ],
+ "blueprintId": "A String", # reference to Blueprint Controller deployment and revision resource
+ "cloudbuildId": "A String", # Cloud Build instance UUID associated with this revision, without any suffix or prefix
+ "errorCode": "A String", # Output only. Code describing any errors that may have occurred. If not specified, there is no error in actuation.
+ "errorLogs": "A String", # A link to actuation cloud build log.
+ "hasUserFacingErrorMsg": True or False, # Output only. whether the error message is user facing. If true, the error message will be shown in the UI.
+ "terraformError": "A String", # Output only. error message return from terraform.
+ "terraformTemplate": "A String", # reference to terraform template used
+ },
+ "deploymentOutput": [ # Output only. [Output only] Deployment output
+ { # Message for output of deployment resource
+ "name": "A String", # name of the resource
+ "type": "A String", # type of the resource
+ },
+ ],
+ "endTime": "A String", # Output only. [Output only] End time stamp
+ "name": "A String", # The name of actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}
+ "startTime": "A String", # Output only. [Output only] Start time stamp
+ "state": "A String", # Output only. [Output only] Actuation state
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists Actuations in a given project, location and deployment.
+
+Args:
+ parent: string, Required. The resource prefix of the Actuation using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}' (required)
+ filter: string, Optional. Filtering results
+ orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response object from `ListActuations`.
+ "actuations": [ # The list of Actuation
+ { # The Actuation object represents the bootstrap state and output results of deployed infrastructure and software.
+ "actuationOutput": { # Message for output of Actuation # Output only. [Output only] Actuation output
+ "actuateLogs": "A String", # A link to gcs file that store build logs
+ "ansibleError": "A String", # Output only. error message return from ansible.
+ "ansibleFailedTask": [ # Output only. failed task name return from ansible.
+ "A String",
+ ],
+ "blueprintId": "A String", # reference to Blueprint Controller deployment and revision resource
+ "cloudbuildId": "A String", # Cloud Build instance UUID associated with this revision, without any suffix or prefix
+ "errorCode": "A String", # Output only. Code describing any errors that may have occurred. If not specified, there is no error in actuation.
+ "errorLogs": "A String", # A link to actuation cloud build log.
+ "hasUserFacingErrorMsg": True or False, # Output only. whether the error message is user facing. If true, the error message will be shown in the UI.
+ "terraformError": "A String", # Output only. error message return from terraform.
+ "terraformTemplate": "A String", # reference to terraform template used
+ },
+ "deploymentOutput": [ # Output only. [Output only] Deployment output
+ { # Message for output of deployment resource
+ "name": "A String", # name of the resource
+ "type": "A String", # type of the resource
+ },
+ ],
+ "endTime": "A String", # Output only. [Output only] End time stamp
+ "name": "A String", # The name of actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}
+ "startTime": "A String", # Output only. [Output only] Start time stamp
+ "state": "A String", # Output only. [Output only] Actuation state
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "unreachable": [ # Unordered list. Locations that could not be reached.
+ "A String",
+ ],
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next()</code>
+ <pre>Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/workloadmanager_v1.projects.locations.deployments.html b/docs/dyn/workloadmanager_v1.projects.locations.deployments.html
new file mode 100644
index 0000000..3b4e252
--- /dev/null
+++ b/docs/dyn/workloadmanager_v1.projects.locations.deployments.html
@@ -0,0 +1,625 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="workloadmanager_v1.html">Workload Manager API</a> . <a href="workloadmanager_v1.projects.html">projects</a> . <a href="workloadmanager_v1.projects.locations.html">locations</a> . <a href="workloadmanager_v1.projects.locations.deployments.html">deployments</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="workloadmanager_v1.projects.locations.deployments.actuations.html">actuations()</a></code>
+</p>
+<p class="firstline">Returns the actuations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#create">create(parent, body=None, deploymentId=None, requestId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new Deployment in a given project and location.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a single Deployment.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets details of a single Deployment.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists Deployments in a given project and location.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next()</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="create">create(parent, body=None, deploymentId=None, requestId=None, x__xgafv=None)</code>
+ <pre>Creates a new Deployment in a given project and location.
+
+Args:
+ parent: string, Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The Deployment object represents user intent for deploying a specific type of workload.
+ "createTime": "A String", # Output only. [Output only] Create time stamp
+ "description": "A String", # Description of the Deployment
+ "name": "A String", # The name of deployment resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'
+ "sapSystemS4Config": { # Message for sap system workload # SAP system workload input
+ "allowStoppingForUpdate": True or False,
+ "ansibleRunnerServiceAccount": "A String", # Ansible runner service account - let custoemrs bring their own SA for Ansible runner
+ "app": { # Message for sap instant details # instance details
+ "appInstanceId": "A String", # Optional. instance id for app
+ "appServiceAccount": "A String", # Application service account - let custoemrs bring their own SA for application
+ "appVmNames": [ # Optional. Customized vm names
+ "A String",
+ ],
+ "ascsImage": "A String", # Required. image for ascs server
+ "ascsInstanceId": "A String", # Optional. instance id for ascs
+ "ascsMachineType": "A String", # Required. ascs_machine_type
+ "ascsServiceAccount": "A String", # ASCS service account - let custoemrs bring their own SA for ASCS
+ "ascsVm": "A String", # Optional. ASCS vm name
+ "ersInstanceId": "A String", # Optional. instance id for ers
+ "ersVm": "A String", # Optional. ERS vm name
+ "image": "A String", # Required. image for app server and ascs server
+ "machineType": "A String", # Required. machine type
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "sharedStorage": "A String", # Optional. Storage location
+ "sid": "A String", # Required. The SAP SID is a three-digit server-specific unique identification code.
+ "vmsMultiplier": 42, # Required. vms_multiplier
+ },
+ "database": { # Message for sap instant details # database details
+ "databaseServiceAccount": "A String", # Database service account - let custoemrs bring their own SA for database
+ "diskType": "A String", # Required. disk_type
+ "image": "A String", # Required. image for database server
+ "instanceId": "A String", # Optional. instance id
+ "machineType": "A String", # Required. machine type
+ "primaryDbVm": "A String", # Optional. primary db vm name
+ "secondaryDbVm": "A String", # Optional. secondary db vm name
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "sid": "A String", # Required. The SID is a three-digit server-specific unique identification code.
+ },
+ "deploymentModel": "A String", # Required. two model non-HA and HA supported
+ "environmentType": "A String", # Required. deployment environment
+ "gcpProjectId": "A String", # the project that infrastructure deployed, current only support the same project where the deployment resource exist.
+ "location": { # Message for sap instant details # database details
+ "createCommsFirewall": True or False, # Optional. create firewall, if true, create firewall for the deployment. This field provides an option to not always create firewall for the deployment.
+ "customTags": [ # Optional. network tags
+ "A String",
+ ],
+ "deploymentDnsEnabled": True or False, # Optional. when user skip DNS configuration from UI, deployment_dns_enabled=false otherwise deployment_dns_enabled=true
+ "dnsZone": "A String", # Optional. dns zone name
+ "dnsZoneNameSuffix": "A String", # Optional. dns_zone_name_suffix
+ "internetAccess": "A String",
+ "networkProject": "A String", # Optional. network project
+ "regionName": "A String", # Required. region_name
+ "subnetName": "A String", # Required. subnet_name
+ "vpcName": "A String", # Required. vpc_name
+ "zone1Name": "A String", # Required. zone1_name
+ "zone2Name": "A String", # Optional. zone2_name
+ },
+ "mediaBucketName": "A String", # Required. media_bucket_name
+ "sapBootDiskImage": "A String", # Optional. sap_boot_disk_image
+ "scalingMethod": "A String", # Required. support scale up and scale out
+ "version": "A String", # Required. sap hana version
+ "vmPrefix": "A String", # vm_prefix
+ },
+ "serviceAccount": "A String", # User-specified Service Account (SA) credentials to be used for cloud build Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation
+ "sqlServerWorkload": { # Message for MS SQL workload # MS SQL workload input
+ "activeDirectory": { # Active directory details # Required. active directory details
+ "dnsAddress": "A String", # Optional. DNS IP address
+ "domain": "A String", # Optional. human readable form of a domain such as “google.com”.
+ "domainUsername": "A String", # Optional. domain username
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "type": "A String", # Required. active directory type
+ },
+ "computeEngineServiceAccount": "A String", # Compute engine service account - let customers bring their own SA for Compute engine
+ "database": { # Database details # Required. database details
+ "diskType": "A String", # Required. disk_type
+ "floatingIpAddress": "A String", # Optional. only useful for Linux High Availability setup
+ "machineType": "A String", # Required. machine type
+ "secondarySoleTenantNode": "A String", # Optional. the name of a secondary-sole-tenant node/node group
+ "secondarySoleTenantNodeType": "A String", # Optional. the type of a secondary-sole-tenant node/node group e.g. compute.googleapis.com/node-name
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "smt": True or False, # Required. whether simultaneous multithreading is enabled or not
+ "soleTenantNode": "A String", # Optional. the name of a primary sole-tenant node/node group
+ "soleTenantNodeType": "A String", # Optional. the type of a primary sole-tenant node/node group e.g. compute.googleapis.com/node-name
+ "tempdbOnSsd": True or False, # Required. whether to have TempDB on local SSD
+ "tenancyModel": "A String", # Required. SHARED or SOLE_TENANT
+ },
+ "deploymentModel": "A String", # Required. HIGH_AVAILABILITY or SINGLE_INSTANCE
+ "environmentType": "A String", # Required. deployment environment
+ "fciType": "A String", # Optional. SHARED_DISK or S2D
+ "haType": "A String", # Optional. AOAG or FCI, it is only needed for High Availability deployment mode
+ "isSqlPayg": True or False, # Required. SQL licensing type
+ "location": { # Location and networking details for configuring SQL server workload # Required. location details
+ "dnsZone": "A String", # Optional. create a new DNS Zone when the field is empty, Only show for `Using an existing DNS` List of existing DNS Zones tf variable name: existing_dns_zone_name
+ "gcpProjectId": "A String", # Required. the project that infrastructure deployed, currently only supports the same project where the deployment resource exists.
+ "internetAccess": "A String", # Required. Internet Access
+ "network": "A String", # Required. network name
+ "primaryZone": "A String", # Required. primary zone
+ "region": "A String", # Required. region name
+ "secondaryZone": "A String", # Optional. secondary zone can't be same as primary_zone and is only for High Availability deployment mode
+ "subnetwork": "A String", # Required. subnetwork name
+ "tertiaryZone": "A String", # Optional. teriary zone can't be same as primary_zone and secondary zone, and it is only for High Availability deployment mode
+ },
+ "mediaBucket": "A String", # Required. name of the media storing SQL server installation files
+ "operatingSystemType": "A String", # Required. type of the operating system the SQL server is going to run on top of
+ "osImage": "A String", # Required. the image of the operating system
+ "osImageType": "A String", # Optional. OS image type, it's used to create boot disks for VM instances When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and default to custom image
+ "pacemaker": { # pacemaker configuration # Optional. pacemaker configuration, only applicable for Linux HA deployments
+ "bucketNameNodeCertificates": "A String", # Required. bucket location for node certificates
+ "pacemakerCluster": "A String", # Required. pacemaker cluster name
+ "pacemakerClusterSecret": "A String", # Required. pacemaker cluster secret name
+ "pacemakerClusterUsername": "A String", # Required. pacemaker cluster username
+ "sqlPacemakerSecret": "A String", # Required. sql pacemaker secret name
+ "sqlPacemakerUsername": "A String", # Required. sql pacemaker username
+ },
+ "sqlServerEdition": "A String", # Optional. SQL Server Edition type, only applicable when Operating System is Linux
+ "sqlServerVersion": "A String", # Optional. 2017 or 2019 or 2022
+ "vmPrefix": "A String", # Required. should be unique in the project
+ },
+ "state": "A String", # Output only. Current state of the deployment.
+ "terraformVariables": { # Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
+ "a_key": { # In order to align with Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest A Terraform input variable.
+ "inputValue": "", # Optional. Input variable value.
+ },
+ },
+ "updateTime": "A String", # Output only. [Output only] Update time stamp
+ "workerPool": "A String", # Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
+ "workloadType": "A String", # Optional. Workload type of the deployment
+}
+
+ deploymentId: string, Required. Id of the deployment
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
+ <pre>Deletes a single Deployment.
+
+Args:
+ name: string, Required. Name of the resource (required)
+ force: boolean, Optional. If set to true, any actuation will also be deleted. Followed the best practice from https://aip.dev/135#cascading-delete
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets details of a single Deployment.
+
+Args:
+ name: string, Required. Name of the resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}' (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The Deployment object represents user intent for deploying a specific type of workload.
+ "createTime": "A String", # Output only. [Output only] Create time stamp
+ "description": "A String", # Description of the Deployment
+ "name": "A String", # The name of deployment resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'
+ "sapSystemS4Config": { # Message for sap system workload # SAP system workload input
+ "allowStoppingForUpdate": True or False,
+ "ansibleRunnerServiceAccount": "A String", # Ansible runner service account - let custoemrs bring their own SA for Ansible runner
+ "app": { # Message for sap instant details # instance details
+ "appInstanceId": "A String", # Optional. instance id for app
+ "appServiceAccount": "A String", # Application service account - let custoemrs bring their own SA for application
+ "appVmNames": [ # Optional. Customized vm names
+ "A String",
+ ],
+ "ascsImage": "A String", # Required. image for ascs server
+ "ascsInstanceId": "A String", # Optional. instance id for ascs
+ "ascsMachineType": "A String", # Required. ascs_machine_type
+ "ascsServiceAccount": "A String", # ASCS service account - let custoemrs bring their own SA for ASCS
+ "ascsVm": "A String", # Optional. ASCS vm name
+ "ersInstanceId": "A String", # Optional. instance id for ers
+ "ersVm": "A String", # Optional. ERS vm name
+ "image": "A String", # Required. image for app server and ascs server
+ "machineType": "A String", # Required. machine type
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "sharedStorage": "A String", # Optional. Storage location
+ "sid": "A String", # Required. The SAP SID is a three-digit server-specific unique identification code.
+ "vmsMultiplier": 42, # Required. vms_multiplier
+ },
+ "database": { # Message for sap instant details # database details
+ "databaseServiceAccount": "A String", # Database service account - let custoemrs bring their own SA for database
+ "diskType": "A String", # Required. disk_type
+ "image": "A String", # Required. image for database server
+ "instanceId": "A String", # Optional. instance id
+ "machineType": "A String", # Required. machine type
+ "primaryDbVm": "A String", # Optional. primary db vm name
+ "secondaryDbVm": "A String", # Optional. secondary db vm name
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "sid": "A String", # Required. The SID is a three-digit server-specific unique identification code.
+ },
+ "deploymentModel": "A String", # Required. two model non-HA and HA supported
+ "environmentType": "A String", # Required. deployment environment
+ "gcpProjectId": "A String", # the project that infrastructure deployed, current only support the same project where the deployment resource exist.
+ "location": { # Message for sap instant details # database details
+ "createCommsFirewall": True or False, # Optional. create firewall, if true, create firewall for the deployment. This field provides an option to not always create firewall for the deployment.
+ "customTags": [ # Optional. network tags
+ "A String",
+ ],
+ "deploymentDnsEnabled": True or False, # Optional. when user skip DNS configuration from UI, deployment_dns_enabled=false otherwise deployment_dns_enabled=true
+ "dnsZone": "A String", # Optional. dns zone name
+ "dnsZoneNameSuffix": "A String", # Optional. dns_zone_name_suffix
+ "internetAccess": "A String",
+ "networkProject": "A String", # Optional. network project
+ "regionName": "A String", # Required. region_name
+ "subnetName": "A String", # Required. subnet_name
+ "vpcName": "A String", # Required. vpc_name
+ "zone1Name": "A String", # Required. zone1_name
+ "zone2Name": "A String", # Optional. zone2_name
+ },
+ "mediaBucketName": "A String", # Required. media_bucket_name
+ "sapBootDiskImage": "A String", # Optional. sap_boot_disk_image
+ "scalingMethod": "A String", # Required. support scale up and scale out
+ "version": "A String", # Required. sap hana version
+ "vmPrefix": "A String", # vm_prefix
+ },
+ "serviceAccount": "A String", # User-specified Service Account (SA) credentials to be used for cloud build Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation
+ "sqlServerWorkload": { # Message for MS SQL workload # MS SQL workload input
+ "activeDirectory": { # Active directory details # Required. active directory details
+ "dnsAddress": "A String", # Optional. DNS IP address
+ "domain": "A String", # Optional. human readable form of a domain such as “google.com”.
+ "domainUsername": "A String", # Optional. domain username
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "type": "A String", # Required. active directory type
+ },
+ "computeEngineServiceAccount": "A String", # Compute engine service account - let customers bring their own SA for Compute engine
+ "database": { # Database details # Required. database details
+ "diskType": "A String", # Required. disk_type
+ "floatingIpAddress": "A String", # Optional. only useful for Linux High Availability setup
+ "machineType": "A String", # Required. machine type
+ "secondarySoleTenantNode": "A String", # Optional. the name of a secondary-sole-tenant node/node group
+ "secondarySoleTenantNodeType": "A String", # Optional. the type of a secondary-sole-tenant node/node group e.g. compute.googleapis.com/node-name
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "smt": True or False, # Required. whether simultaneous multithreading is enabled or not
+ "soleTenantNode": "A String", # Optional. the name of a primary sole-tenant node/node group
+ "soleTenantNodeType": "A String", # Optional. the type of a primary sole-tenant node/node group e.g. compute.googleapis.com/node-name
+ "tempdbOnSsd": True or False, # Required. whether to have TempDB on local SSD
+ "tenancyModel": "A String", # Required. SHARED or SOLE_TENANT
+ },
+ "deploymentModel": "A String", # Required. HIGH_AVAILABILITY or SINGLE_INSTANCE
+ "environmentType": "A String", # Required. deployment environment
+ "fciType": "A String", # Optional. SHARED_DISK or S2D
+ "haType": "A String", # Optional. AOAG or FCI, it is only needed for High Availability deployment mode
+ "isSqlPayg": True or False, # Required. SQL licensing type
+ "location": { # Location and networking details for configuring SQL server workload # Required. location details
+ "dnsZone": "A String", # Optional. create a new DNS Zone when the field is empty, Only show for `Using an existing DNS` List of existing DNS Zones tf variable name: existing_dns_zone_name
+ "gcpProjectId": "A String", # Required. the project that infrastructure deployed, currently only supports the same project where the deployment resource exists.
+ "internetAccess": "A String", # Required. Internet Access
+ "network": "A String", # Required. network name
+ "primaryZone": "A String", # Required. primary zone
+ "region": "A String", # Required. region name
+ "secondaryZone": "A String", # Optional. secondary zone can't be same as primary_zone and is only for High Availability deployment mode
+ "subnetwork": "A String", # Required. subnetwork name
+ "tertiaryZone": "A String", # Optional. teriary zone can't be same as primary_zone and secondary zone, and it is only for High Availability deployment mode
+ },
+ "mediaBucket": "A String", # Required. name of the media storing SQL server installation files
+ "operatingSystemType": "A String", # Required. type of the operating system the SQL server is going to run on top of
+ "osImage": "A String", # Required. the image of the operating system
+ "osImageType": "A String", # Optional. OS image type, it's used to create boot disks for VM instances When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and default to custom image
+ "pacemaker": { # pacemaker configuration # Optional. pacemaker configuration, only applicable for Linux HA deployments
+ "bucketNameNodeCertificates": "A String", # Required. bucket location for node certificates
+ "pacemakerCluster": "A String", # Required. pacemaker cluster name
+ "pacemakerClusterSecret": "A String", # Required. pacemaker cluster secret name
+ "pacemakerClusterUsername": "A String", # Required. pacemaker cluster username
+ "sqlPacemakerSecret": "A String", # Required. sql pacemaker secret name
+ "sqlPacemakerUsername": "A String", # Required. sql pacemaker username
+ },
+ "sqlServerEdition": "A String", # Optional. SQL Server Edition type, only applicable when Operating System is Linux
+ "sqlServerVersion": "A String", # Optional. 2017 or 2019 or 2022
+ "vmPrefix": "A String", # Required. should be unique in the project
+ },
+ "state": "A String", # Output only. Current state of the deployment.
+ "terraformVariables": { # Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
+ "a_key": { # In order to align with Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest A Terraform input variable.
+ "inputValue": "", # Optional. Input variable value.
+ },
+ },
+ "updateTime": "A String", # Output only. [Output only] Update time stamp
+ "workerPool": "A String", # Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
+ "workloadType": "A String", # Optional. Workload type of the deployment
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists Deployments in a given project and location.
+
+Args:
+ parent: string, Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}` (required)
+ filter: string, Optional. Filter resource follow https://google.aip.dev/160
+ orderBy: string, Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing Deployments
+ "deployments": [ # The list of Deployment
+ { # The Deployment object represents user intent for deploying a specific type of workload.
+ "createTime": "A String", # Output only. [Output only] Create time stamp
+ "description": "A String", # Description of the Deployment
+ "name": "A String", # The name of deployment resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'
+ "sapSystemS4Config": { # Message for sap system workload # SAP system workload input
+ "allowStoppingForUpdate": True or False,
+ "ansibleRunnerServiceAccount": "A String", # Ansible runner service account - let custoemrs bring their own SA for Ansible runner
+ "app": { # Message for sap instant details # instance details
+ "appInstanceId": "A String", # Optional. instance id for app
+ "appServiceAccount": "A String", # Application service account - let custoemrs bring their own SA for application
+ "appVmNames": [ # Optional. Customized vm names
+ "A String",
+ ],
+ "ascsImage": "A String", # Required. image for ascs server
+ "ascsInstanceId": "A String", # Optional. instance id for ascs
+ "ascsMachineType": "A String", # Required. ascs_machine_type
+ "ascsServiceAccount": "A String", # ASCS service account - let custoemrs bring their own SA for ASCS
+ "ascsVm": "A String", # Optional. ASCS vm name
+ "ersInstanceId": "A String", # Optional. instance id for ers
+ "ersVm": "A String", # Optional. ERS vm name
+ "image": "A String", # Required. image for app server and ascs server
+ "machineType": "A String", # Required. machine type
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "sharedStorage": "A String", # Optional. Storage location
+ "sid": "A String", # Required. The SAP SID is a three-digit server-specific unique identification code.
+ "vmsMultiplier": 42, # Required. vms_multiplier
+ },
+ "database": { # Message for sap instant details # database details
+ "databaseServiceAccount": "A String", # Database service account - let custoemrs bring their own SA for database
+ "diskType": "A String", # Required. disk_type
+ "image": "A String", # Required. image for database server
+ "instanceId": "A String", # Optional. instance id
+ "machineType": "A String", # Required. machine type
+ "primaryDbVm": "A String", # Optional. primary db vm name
+ "secondaryDbVm": "A String", # Optional. secondary db vm name
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "sid": "A String", # Required. The SID is a three-digit server-specific unique identification code.
+ },
+ "deploymentModel": "A String", # Required. two model non-HA and HA supported
+ "environmentType": "A String", # Required. deployment environment
+ "gcpProjectId": "A String", # the project that infrastructure deployed, current only support the same project where the deployment resource exist.
+ "location": { # Message for sap instant details # database details
+ "createCommsFirewall": True or False, # Optional. create firewall, if true, create firewall for the deployment. This field provides an option to not always create firewall for the deployment.
+ "customTags": [ # Optional. network tags
+ "A String",
+ ],
+ "deploymentDnsEnabled": True or False, # Optional. when user skip DNS configuration from UI, deployment_dns_enabled=false otherwise deployment_dns_enabled=true
+ "dnsZone": "A String", # Optional. dns zone name
+ "dnsZoneNameSuffix": "A String", # Optional. dns_zone_name_suffix
+ "internetAccess": "A String",
+ "networkProject": "A String", # Optional. network project
+ "regionName": "A String", # Required. region_name
+ "subnetName": "A String", # Required. subnet_name
+ "vpcName": "A String", # Required. vpc_name
+ "zone1Name": "A String", # Required. zone1_name
+ "zone2Name": "A String", # Optional. zone2_name
+ },
+ "mediaBucketName": "A String", # Required. media_bucket_name
+ "sapBootDiskImage": "A String", # Optional. sap_boot_disk_image
+ "scalingMethod": "A String", # Required. support scale up and scale out
+ "version": "A String", # Required. sap hana version
+ "vmPrefix": "A String", # vm_prefix
+ },
+ "serviceAccount": "A String", # User-specified Service Account (SA) credentials to be used for cloud build Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation
+ "sqlServerWorkload": { # Message for MS SQL workload # MS SQL workload input
+ "activeDirectory": { # Active directory details # Required. active directory details
+ "dnsAddress": "A String", # Optional. DNS IP address
+ "domain": "A String", # Optional. human readable form of a domain such as “google.com”.
+ "domainUsername": "A String", # Optional. domain username
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "type": "A String", # Required. active directory type
+ },
+ "computeEngineServiceAccount": "A String", # Compute engine service account - let customers bring their own SA for Compute engine
+ "database": { # Database details # Required. database details
+ "diskType": "A String", # Required. disk_type
+ "floatingIpAddress": "A String", # Optional. only useful for Linux High Availability setup
+ "machineType": "A String", # Required. machine type
+ "secondarySoleTenantNode": "A String", # Optional. the name of a secondary-sole-tenant node/node group
+ "secondarySoleTenantNodeType": "A String", # Optional. the type of a secondary-sole-tenant node/node group e.g. compute.googleapis.com/node-name
+ "secretManagerSecret": "A String", # Required. secret_manager_secret
+ "smt": True or False, # Required. whether simultaneous multithreading is enabled or not
+ "soleTenantNode": "A String", # Optional. the name of a primary sole-tenant node/node group
+ "soleTenantNodeType": "A String", # Optional. the type of a primary sole-tenant node/node group e.g. compute.googleapis.com/node-name
+ "tempdbOnSsd": True or False, # Required. whether to have TempDB on local SSD
+ "tenancyModel": "A String", # Required. SHARED or SOLE_TENANT
+ },
+ "deploymentModel": "A String", # Required. HIGH_AVAILABILITY or SINGLE_INSTANCE
+ "environmentType": "A String", # Required. deployment environment
+ "fciType": "A String", # Optional. SHARED_DISK or S2D
+ "haType": "A String", # Optional. AOAG or FCI, it is only needed for High Availability deployment mode
+ "isSqlPayg": True or False, # Required. SQL licensing type
+ "location": { # Location and networking details for configuring SQL server workload # Required. location details
+ "dnsZone": "A String", # Optional. create a new DNS Zone when the field is empty, Only show for `Using an existing DNS` List of existing DNS Zones tf variable name: existing_dns_zone_name
+ "gcpProjectId": "A String", # Required. the project that infrastructure deployed, currently only supports the same project where the deployment resource exists.
+ "internetAccess": "A String", # Required. Internet Access
+ "network": "A String", # Required. network name
+ "primaryZone": "A String", # Required. primary zone
+ "region": "A String", # Required. region name
+ "secondaryZone": "A String", # Optional. secondary zone can't be same as primary_zone and is only for High Availability deployment mode
+ "subnetwork": "A String", # Required. subnetwork name
+ "tertiaryZone": "A String", # Optional. teriary zone can't be same as primary_zone and secondary zone, and it is only for High Availability deployment mode
+ },
+ "mediaBucket": "A String", # Required. name of the media storing SQL server installation files
+ "operatingSystemType": "A String", # Required. type of the operating system the SQL server is going to run on top of
+ "osImage": "A String", # Required. the image of the operating system
+ "osImageType": "A String", # Optional. OS image type, it's used to create boot disks for VM instances When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and default to custom image
+ "pacemaker": { # pacemaker configuration # Optional. pacemaker configuration, only applicable for Linux HA deployments
+ "bucketNameNodeCertificates": "A String", # Required. bucket location for node certificates
+ "pacemakerCluster": "A String", # Required. pacemaker cluster name
+ "pacemakerClusterSecret": "A String", # Required. pacemaker cluster secret name
+ "pacemakerClusterUsername": "A String", # Required. pacemaker cluster username
+ "sqlPacemakerSecret": "A String", # Required. sql pacemaker secret name
+ "sqlPacemakerUsername": "A String", # Required. sql pacemaker username
+ },
+ "sqlServerEdition": "A String", # Optional. SQL Server Edition type, only applicable when Operating System is Linux
+ "sqlServerVersion": "A String", # Optional. 2017 or 2019 or 2022
+ "vmPrefix": "A String", # Required. should be unique in the project
+ },
+ "state": "A String", # Output only. Current state of the deployment.
+ "terraformVariables": { # Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { "project_id": { "input_value": { "string_value": "my-project-id" } }, "zone": { "input_value": { "string_value": "us-central1-a" } } }
+ "a_key": { # In order to align with Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest A Terraform input variable.
+ "inputValue": "", # Optional. Input variable value.
+ },
+ },
+ "updateTime": "A String", # Output only. [Output only] Update time stamp
+ "workerPool": "A String", # Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.
+ "workloadType": "A String", # Optional. Workload type of the deployment
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return.
+ "unreachable": [ # Unordered list. Locations that could not be reached.
+ "A String",
+ ],
+}</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next()</code>
+ <pre>Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/workloadmanager_v1.projects.locations.html b/docs/dyn/workloadmanager_v1.projects.locations.html
index e8d188a..d953cc7 100644
--- a/docs/dyn/workloadmanager_v1.projects.locations.html
+++ b/docs/dyn/workloadmanager_v1.projects.locations.html
@@ -75,6 +75,11 @@
<h1><a href="workloadmanager_v1.html">Workload Manager API</a> . <a href="workloadmanager_v1.projects.html">projects</a> . <a href="workloadmanager_v1.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="workloadmanager_v1.projects.locations.deployments.html">deployments()</a></code>
+</p>
+<p class="firstline">Returns the deployments Resource.</p>
+
+<p class="toc_element">
<code><a href="workloadmanager_v1.projects.locations.discoveredprofiles.html">discoveredprofiles()</a></code>
</p>
<p class="firstline">Returns the discoveredprofiles Resource.</p>
diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
index c2d5908..aaa7206 100644
--- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json
+++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
@@ -641,6 +641,46 @@
"https://www.googleapis.com/auth/admin.directory.device.chromeos"
]
},
+"countChromeOsDevices": {
+"description": "Counts ChromeOS devices matching the request.",
+"flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices",
+"httpMethod": "GET",
+"id": "admin.customer.devices.chromeos.countChromeOsDevices",
+"parameterOrder": [
+"customerId"
+],
+"parameters": {
+"customerId": {
+"description": "Required. Immutable ID of the Google Workspace account.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"filter": {
+"description": "Optional. Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators",
+"location": "query",
+"type": "string"
+},
+"includeChildOrgunits": {
+"description": "Optional. Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided.",
+"location": "query",
+"type": "boolean"
+},
+"orgUnitPath": {
+"description": "Optional. The full path of the organizational unit (minus the leading `/`) or its unique ID.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices",
+"response": {
+"$ref": "CountChromeOsDevicesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/admin.directory.device.chromeos",
+"https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
+]
+},
"issueCommand": {
"description": "Issues a command for the device to execute.",
"flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand",
@@ -4689,7 +4729,7 @@
}
}
},
-"revision": "20260113",
+"revision": "20260210",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Alias": {
@@ -6089,6 +6129,18 @@
},
"type": "object"
},
+"CountChromeOsDevicesResponse": {
+"description": "A response for counting ChromeOS devices.",
+"id": "CountChromeOsDevicesResponse",
+"properties": {
+"count": {
+"description": "The total number of devices matching the request.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
"CreatePrintServerRequest": {
"description": "Request for adding a new print server.",
"id": "CreatePrintServerRequest",
diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json
index 4da1148..9b43a94 100644
--- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json
+++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json
@@ -126,6 +126,11 @@
"location": "query",
"type": "string"
},
+"applicationInfoFilter": {
+"description": "Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId=\"clientId\" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ```",
+"location": "query",
+"type": "string"
+},
"applicationName": {
"description": "Application name for which the events are to be retrieved.",
"enum": [
@@ -251,6 +256,11 @@
"minimum": "1",
"type": "integer"
},
+"networkInfoFilter": {
+"description": "Optional. Used to filter on the `regionCode` field present in [`NetworkInfo`](#networkinfo) message. **Usage** ``` GET...&networkInfoFilter=regionCode=\"IN\" GET...&networkInfoFilter=regionCode=%22IN%22 ```",
+"location": "query",
+"type": "string"
+},
"orgUnitID": {
"default": "",
"description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
@@ -274,6 +284,11 @@
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
"type": "string"
},
+"statusFilter": {
+"description": "Optional. Used to filter on the `statusCode` field present in [`Status`](#status) message. **Usage** ``` GET...&statusFilter=statusCode=\"200\" GET...&statusFilter=statusCode=%22200%22 ```",
+"location": "query",
+"type": "string"
+},
"userKey": {
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`.",
"location": "path",
@@ -666,7 +681,7 @@
}
}
},
-"revision": "20251202",
+"revision": "20260210",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Activities": {
@@ -829,6 +844,10 @@
},
"type": "array"
},
+"status": {
+"$ref": "ActivityEventsStatus",
+"description": "Status of the event. Note: Not all events have status."
+},
"type": {
"description": "Type of event. The Google Workspace service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.",
"type": "string"
@@ -889,6 +908,30 @@
},
"type": "object"
},
+"ActivityEventsStatus": {
+"description": "Status of the event. Note: Not all events have status.",
+"id": "ActivityEventsStatus",
+"properties": {
+"errorCode": {
+"description": "Error code of the event. Note: Field can be empty.",
+"type": "string"
+},
+"errorMessage": {
+"description": "Error message of the event. Note: Field can be empty.",
+"type": "string"
+},
+"eventStatus": {
+"description": "* Status of the event. Possible values if not empty: - UNKNOWN_EVENT_STATUS - SUCCEEDED - SUCCEEDED_WITH_WARNINGS - FAILED - SKIPPED",
+"type": "string"
+},
+"httpStatusCode": {
+"description": "Status code of the event. Note: Field can be empty.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
"ActivityNetworkInfo": {
"description": "Network information of the user doing the action.",
"id": "ActivityNetworkInfo",
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
index 74f90d0..da4d181 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
@@ -30724,7 +30724,7 @@
}
}
},
-"revision": "20260201",
+"revision": "20260208",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -33013,6 +33013,11 @@
"description": "Required. The name of the candidate that produced the response.",
"type": "string"
},
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Output only. Error while scraping model or agent.",
+"readOnly": true
+},
"text": {
"description": "Text response.",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
index a317cf5..e2bf598 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
@@ -3096,6 +3096,110 @@
}
}
},
+"evaluationMetrics": {
+"resources": {
+"operations": {
+"methods": {
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.evaluationMetrics.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^evaluationMetrics/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.evaluationMetrics.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^evaluationMetrics/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationMetrics/{evaluationMetricsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.evaluationMetrics.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^evaluationMetrics/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
"evaluationRuns": {
"resources": {
"operations": {
@@ -13438,6 +13542,110 @@
}
}
},
+"evaluationMetrics": {
+"resources": {
+"operations": {
+"methods": {
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.evaluationMetrics.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationMetrics.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationMetrics.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
"evaluationRuns": {
"methods": {
"cancel": {
@@ -37861,7 +38069,7 @@
}
}
},
-"revision": "20260201",
+"revision": "20260208",
"rootUrl": "https://aiplatform.googleapis.com/",
"schemas": {
"CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -40437,6 +40645,11 @@
"description": "Required. The name of the candidate that produced the response.",
"type": "string"
},
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Output only. Error while scraping model or agent.",
+"readOnly": true
+},
"events": {
"description": "Optional. Intermediate events (such as tool calls and responses) that led to the final response.",
"items": {
@@ -49425,6 +49638,10 @@
"description": "Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
"type": "string"
},
+"modelArmorConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelArmorConfig",
+"description": "Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied."
+},
"safetySettings": {
"description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.",
"items": {
@@ -64278,6 +64495,11 @@
"description": "Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.",
"readOnly": true
},
+"maxConcurrentActiveRunCount": {
+"description": "Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.",
+"format": "int64",
+"type": "string"
+},
"maxConcurrentRunCount": {
"description": "Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).",
"format": "int64",
diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json
index 285c660..82cdb66 100644
--- a/googleapiclient/discovery_cache/documents/alloydb.v1.json
+++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json
@@ -1879,7 +1879,7 @@
}
}
},
-"revision": "20260129",
+"revision": "20260205",
"rootUrl": "https://alloydb.googleapis.com/",
"schemas": {
"AuthorizedNetwork": {
@@ -6190,6 +6190,10 @@
"description": "MaintenanceInfo to capture the maintenance details of database resource.",
"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo",
"properties": {
+"currentVersionReleaseDate": {
+"$ref": "GoogleTypeDate",
+"description": "Optional. The date when the current maintenance version was released."
+},
"denyMaintenanceSchedules": {
"description": "Optional. List of Deny maintenance period for the database resource.",
"items": {
@@ -6235,11 +6239,6 @@
"upcomingMaintenance": {
"$ref": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance",
"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window."
-},
-"versionUpdateTime": {
-"description": "Optional. This field will contain the date when the last version update was applied to the database resource. This will be used to calculate the age of the maintenance version.",
-"format": "google-datetime",
-"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json
index 25b5707..56b0b44 100644
--- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json
@@ -1879,7 +1879,7 @@
}
}
},
-"revision": "20260129",
+"revision": "20260205",
"rootUrl": "https://alloydb.googleapis.com/",
"schemas": {
"AuthorizedNetwork": {
@@ -6384,6 +6384,10 @@
"description": "MaintenanceInfo to capture the maintenance details of database resource.",
"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo",
"properties": {
+"currentVersionReleaseDate": {
+"$ref": "GoogleTypeDate",
+"description": "Optional. The date when the current maintenance version was released."
+},
"denyMaintenanceSchedules": {
"description": "Optional. List of Deny maintenance period for the database resource.",
"items": {
@@ -6429,11 +6433,6 @@
"upcomingMaintenance": {
"$ref": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance",
"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window."
-},
-"versionUpdateTime": {
-"description": "Optional. This field will contain the date when the last version update was applied to the database resource. This will be used to calculate the age of the maintenance version.",
-"format": "google-datetime",
-"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json
index 792da77..2678f0c 100644
--- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json
@@ -1876,7 +1876,7 @@
}
}
},
-"revision": "20260129",
+"revision": "20260205",
"rootUrl": "https://alloydb.googleapis.com/",
"schemas": {
"AuthorizedNetwork": {
@@ -6360,6 +6360,10 @@
"description": "MaintenanceInfo to capture the maintenance details of database resource.",
"id": "StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo",
"properties": {
+"currentVersionReleaseDate": {
+"$ref": "GoogleTypeDate",
+"description": "Optional. The date when the current maintenance version was released."
+},
"denyMaintenanceSchedules": {
"description": "Optional. List of Deny maintenance period for the database resource.",
"items": {
@@ -6405,11 +6409,6 @@
"upcomingMaintenance": {
"$ref": "StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance",
"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window."
-},
-"versionUpdateTime": {
-"description": "Optional. This field will contain the date when the last version update was applied to the database resource. This will be used to calculate the age of the maintenance version.",
-"format": "google-datetime",
-"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json
index ac8840d..391f658 100644
--- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json
+++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json
@@ -1265,7 +1265,7 @@
}
}
},
-"revision": "20260204",
+"revision": "20260212",
"rootUrl": "https://androidmanagement.googleapis.com/",
"schemas": {
"AdbShellCommandEvent": {
@@ -5336,7 +5336,7 @@
"type": "string"
},
"telephonyInfos": {
-"description": "Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23.",
+"description": "Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android 6.",
"items": {
"$ref": "TelephonyInfo"
},
@@ -7613,11 +7613,11 @@
"type": "object"
},
"TelephonyInfo": {
-"description": "Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23.",
+"description": "Telephony information associated with a given SIM card on the device. This is supported for all SIM cards on fully managed devices on Android 6 and above. In addition, this is supported for admin-added eSIMs on all devices for Android 15 and above.",
"id": "TelephonyInfo",
"properties": {
"activationState": {
-"description": "Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below API level 35.",
+"description": "Output only. Activation state of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always ACTIVATION_STATE_UNSPECIFIED for physical SIMs and for devices below Android 15.",
"enum": [
"ACTIVATION_STATE_UNSPECIFIED",
"ACTIVATED",
@@ -7636,7 +7636,7 @@
"type": "string"
},
"configMode": {
-"description": "Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for API level 35 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below API level 35.",
+"description": "Output only. The configuration mode of the SIM card on the device. This is applicable for eSIMs only. This is supported on all devices for Android 15 and above. This is always CONFIG_MODE_UNSPECIFIED for physical SIMs and for devices below Android 15.",
"enum": [
"CONFIG_MODE_UNSPECIFIED",
"ADMIN_CONFIGURED",
diff --git a/googleapiclient/discovery_cache/documents/apihub.v1.json b/googleapiclient/discovery_cache/documents/apihub.v1.json
index 384fa03..92a5aba 100644
--- a/googleapiclient/discovery_cache/documents/apihub.v1.json
+++ b/googleapiclient/discovery_cache/documents/apihub.v1.json
@@ -15,6 +15,53 @@
"description": "",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.asia-east1.rep.googleapis.com/",
+"location": "asia-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.asia-south1.rep.googleapis.com/",
+"location": "asia-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.asia-southeast1.rep.googleapis.com/",
+"location": "asia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.europe-north1.rep.googleapis.com/",
+"location": "europe-north1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.europe-west1.rep.googleapis.com/",
+"location": "europe-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.europe-west9.rep.googleapis.com/",
+"location": "europe-west9"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.us-central1.rep.googleapis.com/",
+"location": "us-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.us-east1.rep.googleapis.com/",
+"location": "us-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.us-west1.rep.googleapis.com/",
+"location": "us-west1"
+}
+],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -163,7 +210,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "apihub.projects.locations.list",
@@ -3173,7 +3220,7 @@
}
}
},
-"revision": "20260119",
+"revision": "20260211",
"rootUrl": "https://apihub.googleapis.com/",
"schemas": {
"Empty": {
diff --git a/googleapiclient/discovery_cache/documents/appsmarket.v2.json b/googleapiclient/discovery_cache/documents/appsmarket.v2.json
index 3c1d0c4..756d322 100644
--- a/googleapiclient/discovery_cache/documents/appsmarket.v2.json
+++ b/googleapiclient/discovery_cache/documents/appsmarket.v2.json
@@ -108,7 +108,7 @@
"customerLicense": {
"methods": {
"get": {
-"description": "Gets the status of a license for a customer to determine if they have access for a given app.",
+"description": "Gets the customer's licensing status to determine if they have access to a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).",
"flatPath": "appsmarket/v2/customerLicense/{applicationId}/{customerId}",
"httpMethod": "GET",
"id": "appsmarket.customerLicense.get",
@@ -118,13 +118,13 @@
],
"parameters": {
"applicationId": {
-"description": "Application Id",
+"description": "The ID of the application.",
"location": "path",
"required": true,
"type": "string"
},
"customerId": {
-"description": "Customer Id",
+"description": "The ID of the customer.",
"location": "path",
"required": true,
"type": "string"
@@ -143,7 +143,7 @@
"userLicense": {
"methods": {
"get": {
-"description": "Gets the user's licensing status for their permission to use a given app.",
+"description": "Gets the user's licensing status to determine if they have permission to use a given app. For more information, see [Getting app installation and licensing details](https://developers.google.com/workspace/marketplace/example-calls-marketplace-api).",
"flatPath": "appsmarket/v2/userLicense/{applicationId}/{userId}",
"httpMethod": "GET",
"id": "appsmarket.userLicense.get",
@@ -153,13 +153,13 @@
],
"parameters": {
"applicationId": {
-"description": "Application Id",
+"description": "The ID of the application.",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
-"description": "User Id",
+"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
@@ -176,7 +176,7 @@
}
}
},
-"revision": "20251217",
+"revision": "20260209",
"rootUrl": "https://appsmarket.googleapis.com/",
"schemas": {
"CustomerLicense": {
@@ -203,11 +203,11 @@
"type": "string"
},
"kind": {
-"description": "The type of API resource. This is always appsmarket#customerLicense.",
+"description": "The type of API resource. This is always `appsmarket#customerLicense`.",
"type": "string"
},
"state": {
-"description": "The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license: either this customer has never installed your application, or else has deleted it.",
+"description": "The customer's license status. One of: - `ACTIVE`: The customer has a valid license. - `UNLICENSED`: There is no license. Either this customer has never installed your application or has deleted it.",
"type": "string"
}
},
@@ -257,11 +257,11 @@
"type": "boolean"
},
"id": {
-"description": "The ID of user license.",
+"description": "The ID of the user license.",
"type": "string"
},
"kind": {
-"description": "The type of API resource. This is always appsmarket#userLicense.",
+"description": "The type of API resource. This is always `appsmarket#userLicense`.",
"type": "string"
},
"state": {
diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json
index 9b4c02f..74fa698 100644
--- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json
+++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json
@@ -464,7 +464,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.list",
@@ -2493,7 +2493,7 @@
}
}
},
-"revision": "20260102",
+"revision": "20260206",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"AptArtifact": {
@@ -3284,12 +3284,14 @@
"enum": [
"HASH_TYPE_UNSPECIFIED",
"SHA256",
-"MD5"
+"MD5",
+"DIRSUM_SHA256"
],
"enumDescriptions": [
"Unspecified.",
"SHA256 hash.",
-"MD5 hash."
+"MD5 hash.",
+"Dirsum SHA256 hash."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json
index 06622be..e53b6b7 100644
--- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json
@@ -376,7 +376,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1beta1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.list",
@@ -1182,7 +1182,7 @@
}
}
},
-"revision": "20251029",
+"revision": "20260206",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"Binding": {
@@ -1284,12 +1284,14 @@
"enum": [
"HASH_TYPE_UNSPECIFIED",
"SHA256",
-"MD5"
+"MD5",
+"DIRSUM_SHA256"
],
"enumDescriptions": [
"Unspecified.",
"SHA256 hash.",
-"MD5 hash."
+"MD5 hash.",
+"Dirsum SHA256 hash."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json
index d34ffc5..e1674c7 100644
--- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json
@@ -438,7 +438,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1beta2/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.list",
@@ -1450,7 +1450,7 @@
}
}
},
-"revision": "20251029",
+"revision": "20260206",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"AptArtifact": {
@@ -1606,12 +1606,14 @@
"enum": [
"HASH_TYPE_UNSPECIFIED",
"SHA256",
-"MD5"
+"MD5",
+"DIRSUM_SHA256"
],
"enumDescriptions": [
"Unspecified.",
"SHA256 hash.",
-"MD5 hash."
+"MD5 hash.",
+"Dirsum SHA256 hash."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/biglake.v1.json b/googleapiclient/discovery_cache/documents/biglake.v1.json
index 41c5b57..bf5f6f7 100644
--- a/googleapiclient/discovery_cache/documents/biglake.v1.json
+++ b/googleapiclient/discovery_cache/documents/biglake.v1.json
@@ -172,6 +172,35 @@
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
+},
+"testIamPermissions": {
+"description": "Tests the IAM permissions for the specified catalog.",
+"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "biglake.projects.catalogs.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/catalogs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:testIamPermissions",
+"request": {
+"$ref": "TestIamPermissionsRequest"
+},
+"response": {
+"$ref": "TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/bigquery",
+"https://www.googleapis.com/auth/cloud-platform"
+]
}
},
"resources": {
@@ -237,6 +266,131 @@
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
+},
+"testIamPermissions": {
+"description": "Tests the IAM permissions for the specified namespace.",
+"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "biglake.projects.catalogs.namespaces.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:testIamPermissions",
+"request": {
+"$ref": "TestIamPermissionsRequest"
+},
+"response": {
+"$ref": "TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/bigquery",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"tables": {
+"methods": {
+"getIamPolicy": {
+"description": "Gets the IAM policy for the specified Catalog.",
+"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}/tables/{tablesId}:getIamPolicy",
+"httpMethod": "GET",
+"id": "biglake.projects.catalogs.namespaces.tables.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+/tables/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/bigquery",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setIamPolicy": {
+"description": "Sets the IAM policy for the specified catalog.",
+"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}/tables/{tablesId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "biglake.projects.catalogs.namespaces.tables.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+/tables/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "SetIamPolicyRequest"
+},
+"response": {
+"$ref": "Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/bigquery",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"testIamPermissions": {
+"description": "Tests the IAM permissions for the specified table.",
+"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}/tables/{tablesId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "biglake.projects.catalogs.namespaces.tables.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+/tables/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:testIamPermissions",
+"request": {
+"$ref": "TestIamPermissionsRequest"
+},
+"response": {
+"$ref": "TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/bigquery",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
}
}
}
@@ -748,7 +902,7 @@
}
}
},
-"revision": "20251027",
+"revision": "20260209",
"rootUrl": "https://biglake.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -1173,6 +1327,34 @@
}
},
"type": "object"
+},
+"TestIamPermissionsRequest": {
+"description": "Request message for `TestIamPermissions` method.",
+"id": "TestIamPermissionsRequest",
+"properties": {
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"TestIamPermissionsResponse": {
+"description": "Response message for `TestIamPermissions` method.",
+"id": "TestIamPermissionsResponse",
+"properties": {
+"permissions": {
+"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
}
},
"servicePath": "",
diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
index 6c569e9..50c87a0 100644
--- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
+++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
@@ -3061,7 +3061,7 @@
"locations": {
"methods": {
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v2/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "bigtableadmin.projects.locations.list",
@@ -3118,7 +3118,7 @@
}
}
},
-"revision": "20251209",
+"revision": "20260210",
"rootUrl": "https://bigtableadmin.googleapis.com/",
"schemas": {
"AppProfile": {
@@ -4395,6 +4395,12 @@
"properties": {},
"type": "object"
},
+"GoogleBigtableAdminV2TypeGeography": {
+"description": "A geography type, representing a point or region on Earth. The value is stored in `Value.bytes_value` as Well-Known Binary (WKB) bytes.",
+"id": "GoogleBigtableAdminV2TypeGeography",
+"properties": {},
+"type": "object"
+},
"GoogleBigtableAdminV2TypeInt64": {
"description": "Int64 Values of type `Int64` are stored in `Value.int_value`.",
"id": "GoogleBigtableAdminV2TypeInt64",
@@ -5719,6 +5725,10 @@
"$ref": "GoogleBigtableAdminV2TypeFloat64",
"description": "Float64"
},
+"geographyType": {
+"$ref": "GoogleBigtableAdminV2TypeGeography",
+"description": "Geography"
+},
"int64Type": {
"$ref": "GoogleBigtableAdminV2TypeInt64",
"description": "Int64"
diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json
index 665c975..1d3c711 100644
--- a/googleapiclient/discovery_cache/documents/ces.v1.json
+++ b/googleapiclient/discovery_cache/documents/ces.v1.json
@@ -904,7 +904,7 @@
"type": "string"
},
"source": {
-"description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.",
+"description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field.",
"enum": [
"SOURCE_UNSPECIFIED",
"LIVE",
@@ -919,6 +919,24 @@
],
"location": "query",
"type": "string"
+},
+"sources": {
+"description": "Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.",
+"enum": [
+"SOURCE_UNSPECIFIED",
+"LIVE",
+"SIMULATOR",
+"EVAL"
+],
+"enumDescriptions": [
+"Unspecified source.",
+"The conversation is from the live end user.",
+"The conversation is from the simulator.",
+"The conversation is from the evaluation."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
}
},
"path": "v1/{+parent}/conversations",
@@ -2228,7 +2246,7 @@
}
}
},
-"revision": "20260204",
+"revision": "20260213",
"rootUrl": "https://ces.googleapis.com/",
"schemas": {
"Action": {
@@ -2966,6 +2984,10 @@
"description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.",
"type": "boolean"
},
+"proactiveExecutionEnabled": {
+"description": "Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.",
+"type": "boolean"
+},
"pythonCode": {
"description": "Required. The python code to execute for the callback.",
"type": "string"
@@ -3458,14 +3480,18 @@
"INPUT_TYPE_TEXT",
"INPUT_TYPE_AUDIO",
"INPUT_TYPE_IMAGE",
-"INPUT_TYPE_BLOB"
+"INPUT_TYPE_BLOB",
+"INPUT_TYPE_TOOL_RESPONSE",
+"INPUT_TYPE_VARIABLES"
],
"enumDescriptions": [
"Unspecified input type.",
"The input message is text.",
"The input message is audio.",
"The input message is image.",
-"The input message is blob file."
+"The input message is blob file.",
+"The input message is client function tool response.",
+"The input message are variables."
],
"type": "string"
},
@@ -4464,6 +4490,25 @@
"type": "string"
},
"type": "array"
+},
+"promptConfig": {
+"$ref": "GoogleSearchToolPromptConfig",
+"description": "Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice."
+}
+},
+"type": "object"
+},
+"GoogleSearchToolPromptConfig": {
+"description": "Prompt settings used by the model when processing or summarizing the google search results.",
+"id": "GoogleSearchToolPromptConfig",
+"properties": {
+"textPrompt": {
+"description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.",
+"type": "string"
+},
+"voicePrompt": {
+"description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.",
+"type": "string"
}
},
"type": "object"
@@ -4773,6 +4818,10 @@
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs:///`.",
"type": "string"
},
+"ignoreAppLock": {
+"description": "Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.",
+"type": "boolean"
+},
"importOptions": {
"$ref": "ImportAppRequestImportOptions",
"description": "Optional. Options governing the import process for the app."
@@ -6760,7 +6809,8 @@
"ADVANCED_PRODUCT_DETAILS",
"SHORT_FORM",
"OVERALL_SATISFACTION",
-"ORDER_SUMMARY"
+"ORDER_SUMMARY",
+"APPOINTMENT_DETAILS"
],
"enumDescriptions": [
"Unspecified widget type.",
@@ -6772,7 +6822,8 @@
"Advanced product details widget.",
"Short form widget.",
"Overall satisfaction widget.",
-"Order summary widget."
+"Order summary widget.",
+"Appointment details widget."
],
"type": "string"
}
diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json
index fec0468..07a7b63 100644
--- a/googleapiclient/discovery_cache/documents/ces.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json
@@ -1020,7 +1020,7 @@
"type": "string"
},
"source": {
-"description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.",
+"description": "Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field.",
"enum": [
"SOURCE_UNSPECIFIED",
"LIVE",
@@ -1035,6 +1035,24 @@
],
"location": "query",
"type": "string"
+},
+"sources": {
+"description": "Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default.",
+"enum": [
+"SOURCE_UNSPECIFIED",
+"LIVE",
+"SIMULATOR",
+"EVAL"
+],
+"enumDescriptions": [
+"Unspecified source.",
+"The conversation is from the live end user.",
+"The conversation is from the simulator.",
+"The conversation is from the evaluation."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
}
},
"path": "v1beta/{+parent}/conversations",
@@ -3270,7 +3288,7 @@
}
}
},
-"revision": "20260204",
+"revision": "20260213",
"rootUrl": "https://ces.googleapis.com/",
"schemas": {
"Action": {
@@ -4268,6 +4286,10 @@
"description": "Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.",
"type": "boolean"
},
+"proactiveExecutionEnabled": {
+"description": "Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.",
+"type": "boolean"
+},
"pythonCode": {
"description": "Required. The python code to execute for the callback.",
"type": "string"
@@ -4760,14 +4782,18 @@
"INPUT_TYPE_TEXT",
"INPUT_TYPE_AUDIO",
"INPUT_TYPE_IMAGE",
-"INPUT_TYPE_BLOB"
+"INPUT_TYPE_BLOB",
+"INPUT_TYPE_TOOL_RESPONSE",
+"INPUT_TYPE_VARIABLES"
],
"enumDescriptions": [
"Unspecified input type.",
"The input message is text.",
"The input message is audio.",
"The input message is image.",
-"The input message is blob file."
+"The input message is blob file.",
+"The input message is client function tool response.",
+"The input message are variables."
],
"type": "string"
},
@@ -7542,6 +7568,25 @@
"type": "string"
},
"type": "array"
+},
+"promptConfig": {
+"$ref": "GoogleSearchToolPromptConfig",
+"description": "Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice."
+}
+},
+"type": "object"
+},
+"GoogleSearchToolPromptConfig": {
+"description": "Prompt settings used by the model when processing or summarizing the google search results.",
+"id": "GoogleSearchToolPromptConfig",
+"properties": {
+"textPrompt": {
+"description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.",
+"type": "string"
+},
+"voicePrompt": {
+"description": "Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.",
+"type": "string"
}
},
"type": "object"
@@ -7851,6 +7896,10 @@
"description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs:///`.",
"type": "string"
},
+"ignoreAppLock": {
+"description": "Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock.",
+"type": "boolean"
+},
"importOptions": {
"$ref": "ImportAppRequestImportOptions",
"description": "Optional. Options governing the import process for the app."
@@ -10501,7 +10550,8 @@
"ADVANCED_PRODUCT_DETAILS",
"SHORT_FORM",
"OVERALL_SATISFACTION",
-"ORDER_SUMMARY"
+"ORDER_SUMMARY",
+"APPOINTMENT_DETAILS"
],
"enumDescriptions": [
"Unspecified widget type.",
@@ -10513,7 +10563,8 @@
"Advanced product details widget.",
"Short form widget.",
"Overall satisfaction widget.",
-"Order summary widget."
+"Order summary widget.",
+"Appointment details widget."
],
"type": "string"
}
diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json
index c17cc80..b9b8f75 100644
--- a/googleapiclient/discovery_cache/documents/chat.v1.json
+++ b/googleapiclient/discovery_cache/documents/chat.v1.json
@@ -1535,7 +1535,7 @@
}
}
},
-"revision": "20260120",
+"revision": "20260205",
"rootUrl": "https://chat.googleapis.com/",
"schemas": {
"AccessSettings": {
@@ -3007,6 +3007,11 @@
"description": "A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.",
"id": "GoogleAppsCardV1DataSourceConfig",
"properties": {
+"minCharactersTrigger": {
+"description": "The minimum number of characters the user must enter before this data provider is triggered (i.e., before it starts returning results).",
+"format": "int32",
+"type": "integer"
+},
"platformDataSource": {
"$ref": "GoogleAppsCardV1PlatformDataSource",
"description": "The data is from a Google Workspace application."
@@ -3600,7 +3605,7 @@
"id": "GoogleAppsCardV1SelectionInput",
"properties": {
"dataSourceConfigs": {
-"description": "Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.",
+"description": "Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps. For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.",
"items": {
"$ref": "GoogleAppsCardV1DataSourceConfig"
},
@@ -3660,7 +3665,7 @@
"A set of checkboxes. Users can select one or more checkboxes.",
"A set of radio buttons. Users can select one radio button.",
"A set of switches. Users can turn on one or more switches.",
-"A dropdown menu. Users can select one item from the menu. For Google Chat apps, as part of the [Developer Preview Program](https://developers.google.com/workspace/preview), you can populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a dropdown menu, use one of the following types of data sources: * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement dropdown menus for Chat apps, see [Add a dropdown menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#dropdown-menu) and [Dynamically populate drop-down menus](https://developers.google.com/workspace/chat/design-interactive-card-dialog#dynamic-dropdown-menu). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
+"A dropdown menu. Users can select one item from the menu. For Google Chat apps, you can populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a dropdown menu, use one of the following types of data sources: * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement dropdown menus for Chat apps, see [Add a dropdown menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#dropdown-menu) and [Dynamically populate drop-down menus](https://developers.google.com/workspace/chat/design-interactive-card-dialog#dynamic-dropdown-menu). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):",
"A menu with a text box. Users can type and select one or more items. For Google Workspace add-ons, you must populate items using a static array of `SelectionItem` objects. For Google Chat apps, you can also populate items using a dynamic data source and autosuggest items as users type in the menu. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To dynamically populate items for a multiselect menu, use one of the following types of data sources: * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus for Chat apps, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):"
],
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json
index bb9eb08..37d7d59 100644
--- a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json
@@ -15,6 +15,13 @@
"description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/error-reporting/",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://clouderrorreporting.us.rep.googleapis.com/",
+"location": "us"
+}
+],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -728,7 +735,7 @@
}
}
},
-"revision": "20240705",
+"revision": "20260206",
"rootUrl": "https://clouderrorreporting.googleapis.com/",
"schemas": {
"DeleteEventsResponse": {
diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json
index 54efa25..9f35805 100644
--- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json
+++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json
@@ -783,7 +783,7 @@
}
}
},
-"revision": "20260129",
+"revision": "20260205",
"rootUrl": "https://cloudfunctions.googleapis.com/",
"schemas": {
"AbortFunctionUpgradeRequest": {
@@ -992,6 +992,28 @@
"properties": {},
"type": "object"
},
+"DirectVpcNetworkInterface": {
+"description": "The Direct VPC network interface. This is mutually exclusive with VPC Connector.",
+"id": "DirectVpcNetworkInterface",
+"properties": {
+"network": {
+"description": "Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.",
+"type": "string"
+},
+"subnetwork": {
+"description": "Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.",
+"type": "string"
+},
+"tags": {
+"description": "Optional. Network tags applied to this Cloud Function resource.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"EventFilter": {
"description": "Filters events based on exact matches on the CloudEvents attributes.",
"id": "EventFilter",
@@ -1923,6 +1945,27 @@
"description": "Optional. The binary authorization policy to be checked when deploying the Cloud Run service.",
"type": "string"
},
+"directVpcEgress": {
+"description": "Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.",
+"enum": [
+"DIRECT_VPC_EGRESS_UNSPECIFIED",
+"VPC_EGRESS_PRIVATE_RANGES_ONLY",
+"VPC_EGRESS_ALL_TRAFFIC"
+],
+"enumDescriptions": [
+"Unspecified.",
+"Sends only traffic to internal addresses through the VPC network.",
+"Sends all outbound traffic through the VPC network."
+],
+"type": "string"
+},
+"directVpcNetworkInterface": {
+"description": "Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.",
+"items": {
+"$ref": "DirectVpcNetworkInterface"
+},
+"type": "array"
+},
"environmentVariables": {
"additionalProperties": {
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
index fef5577..dfd7902 100644
--- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
@@ -269,7 +269,7 @@
],
"parameters": {
"name": {
-"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`",
+"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
"location": "path",
"pattern": "^folders/[^/]+/autokeyConfig$",
"required": true,
@@ -538,7 +538,7 @@
],
"parameters": {
"name": {
-"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`",
+"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
"location": "path",
"pattern": "^projects/[^/]+/autokeyConfig$",
"required": true,
@@ -684,7 +684,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "cloudkms.projects.locations.list",
@@ -1501,6 +1501,32 @@
"https://www.googleapis.com/auth/cloudkms"
]
},
+"delete": {
+"description": "Permanently deletes the given CryptoKey. All child CryptoKeyVersions must have been previously deleted using KeyManagementService.DeleteCryptoKeyVersion. The specified crypto key will be immediately and permanently deleted upon calling this method. This action cannot be undone.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+"httpMethod": "DELETE",
+"id": "cloudkms.projects.locations.keyRings.cryptoKeys.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the CryptoKey to delete.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+},
"encrypt": {
"description": "Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
@@ -1890,6 +1916,32 @@
"https://www.googleapis.com/auth/cloudkms"
]
},
+"delete": {
+"description": "Permanently deletes the given CryptoKeyVersion. Only possible if the version has not been previously imported and if its state is one of DESTROYED, IMPORT_FAILED, or GENERATION_FAILED. Successfully imported CryptoKeyVersions cannot be deleted at this time. The specified version will be immediately and permanently deleted upon calling this method. This action cannot be undone.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+"httpMethod": "DELETE",
+"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the CryptoKeyVersion to delete.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+},
"destroy": {
"description": "Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
@@ -2496,6 +2548,73 @@
}
}
},
+"retiredResources": {
+"methods": {
+"get": {
+"description": "Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/retiredResources/{retiredResourcesId}",
+"httpMethod": "GET",
+"id": "cloudkms.projects.locations.retiredResources.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the RetiredResource to get.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/retiredResources/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "RetiredResource"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+},
+"list": {
+"description": "Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/retiredResources",
+"httpMethod": "GET",
+"id": "cloudkms.projects.locations.retiredResources.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. Optional limit on the number of RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. Optional pagination token, returned earlier via ListRetiredResourcesResponse.next_page_token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The project-specific location holding the RetiredResources, in the format `projects/*/locations/*`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/retiredResources",
+"response": {
+"$ref": "ListRetiredResourcesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+}
+}
+},
"singleTenantHsmInstances": {
"methods": {
"create": {
@@ -2819,7 +2938,7 @@
}
}
},
-"revision": "20260123",
+"revision": "20260206",
"rootUrl": "https://cloudkms.googleapis.com/",
"schemas": {
"AddQuorumMember": {
@@ -3058,13 +3177,13 @@
"enumDescriptions": [
"Default value. KeyProjectResolutionMode when not specified will act as `DEDICATED_KEY_PROJECT`.",
"Keys are created in a dedicated project specified by `key_project`.",
-"Keys are created in the same project as the resource requesting the key. `key_project` must not be set when this mode is used.",
+"Keys are created in the same project as the resource requesting the key. The `key_project` must not be set when this mode is used.",
"Disables the AutokeyConfig. When this mode is set, any AutokeyConfig from higher levels in the resource hierarchy are ignored for this resource and its descendants. This setting can be overridden by a more specific configuration at a lower level. For example, if Autokey is disabled on a folder, it can be re-enabled on a sub-folder or project within that folder by setting a different mode (e.g., DEDICATED_KEY_PROJECT or RESOURCE_PROJECT)."
],
"type": "string"
},
"name": {
-"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`",
+"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
"type": "string"
},
"state": {
@@ -4645,6 +4764,29 @@
},
"type": "object"
},
+"ListRetiredResourcesResponse": {
+"description": "Response message for KeyManagementService.ListRetiredResources.",
+"id": "ListRetiredResourcesResponse",
+"properties": {
+"nextPageToken": {
+"description": "A token to retrieve the next page of results. Pass this value in ListRetiredResourcesRequest.page_token to retrieve the next page of results.",
+"type": "string"
+},
+"retiredResources": {
+"description": "The list of RetiredResources.",
+"items": {
+"$ref": "RetiredResource"
+},
+"type": "array"
+},
+"totalSize": {
+"description": "The total number of RetiredResources that matched the query.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
"ListSingleTenantHsmInstanceProposalsResponse": {
"description": "Response message for HsmManagement.ListSingleTenantHsmInstanceProposals.",
"id": "ListSingleTenantHsmInstanceProposalsResponse",
@@ -5475,6 +5617,34 @@
"properties": {},
"type": "object"
},
+"RetiredResource": {
+"description": "A RetiredResource resource represents the record of a deleted CryptoKey. Its purpose is to provide visibility into retained user data and to prevent reuse of these names for new CryptoKeys.",
+"id": "RetiredResource",
+"properties": {
+"deleteTime": {
+"description": "Output only. The time at which the original resource was deleted and this RetiredResource record was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. Identifier. The resource name for this RetiredResource in the format `projects/*/locations/*/retiredResources/*`.",
+"readOnly": true,
+"type": "string"
+},
+"originalResource": {
+"description": "Output only. The full resource name of the original CryptoKey that was deleted in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+"readOnly": true,
+"type": "string"
+},
+"resourceType": {
+"description": "Output only. The resource type of the original deleted resource.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
"ServiceResolver": {
"description": "A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.",
"id": "ServiceResolver",
diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json
index f825b48..62a9624 100644
--- a/googleapiclient/discovery_cache/documents/compute.alpha.json
+++ b/googleapiclient/discovery_cache/documents/compute.alpha.json
@@ -3234,6 +3234,55 @@
"https://www.googleapis.com/auth/compute"
]
},
+"convert": {
+"description": "Converts a persistent disk to support Gen4+ VMs.",
+"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/convert",
+"httpMethod": "POST",
+"id": "compute.disks.convert",
+"parameterOrder": [
+"project",
+"zone",
+"disk"
+],
+"parameters": {
+"disk": {
+"description": "Name of the Disk resource, should conform to RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"zone": {
+"description": "The name of the zone for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/disks/{disk}/convert",
+"request": {
+"$ref": "DisksConvertRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
"createSnapshot": {
"description": "Creates a snapshot of a specified persistent disk. For regular snapshot\ncreation, consider using snapshots.insert\ninstead, as that method supports more features, such as creating snapshots\nin a project different from the source disk project.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot",
@@ -7181,7 +7230,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/global/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.insert",
@@ -10478,6 +10527,54 @@
"https://www.googleapis.com/auth/compute"
]
},
+"configureAcceleratorTopologies": {
+"description": "Updates the accelerator topologies configuration.",
+"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/configureAcceleratorTopologies",
+"httpMethod": "POST",
+"id": "compute.instanceGroupManagers.configureAcceleratorTopologies",
+"parameterOrder": [
+"project",
+"zone",
+"instanceGroupManager"
+],
+"parameters": {
+"instanceGroupManager": {
+"description": "The name of the managed instance group.\nIt should conform to RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"zone": {
+"description": "The name of thezone\nwhere the managed instance group is located.\nIt should conform to RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/configureAcceleratorTopologies",
+"request": {
+"$ref": "InstanceGroupManagersConfigureAcceleratorTopologiesRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
"createInstances": {
"description": "Creates instances with per-instance configurations in this managed instance\ngroup. Instances are created using the current instance template. Thecreate instances operation is marked DONE if thecreateInstances request is successful. The underlying actions\ntake additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances\nmethod.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances",
@@ -20530,7 +20627,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.insert",
@@ -28805,7 +28902,7 @@
},
"path": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}/getHealth",
"response": {
-"$ref": "CompositeHealthChecksGetHealthResponse"
+"$ref": "CompositeHealthCheckHealth"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -31411,6 +31508,49 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
+"getHealth": {
+"description": "Gets the most recent health check results for this\nregional HealthSource.",
+"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth",
+"httpMethod": "GET",
+"id": "compute.regionHealthSources.getHealth",
+"parameterOrder": [
+"project",
+"region",
+"healthSource"
+],
+"parameters": {
+"healthSource": {
+"description": "Name of the HealthSource resource to get health for.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Name of the project scoping this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"region": {
+"description": "Name of the region scoping this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth",
+"response": {
+"$ref": "HealthSourceHealth"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
"insert": {
"description": "Create a HealthSource in the specified project in the given region\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/healthSources",
@@ -35077,7 +35217,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.regionNetworkEndpointGroups.insert",
@@ -41204,6 +41344,61 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
+"getVersion": {
+"description": "Allows customers to get SBOM versions of a reservation slot.",
+"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getVersion",
+"httpMethod": "POST",
+"id": "compute.reservationSlots.getVersion",
+"parameterOrder": [
+"project",
+"zone",
+"parentName",
+"reservationSlot"
+],
+"parameters": {
+"parentName": {
+"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}",
+"location": "path",
+"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"reservationSlot": {
+"description": "The name of the reservation slot.\nName should conform to RFC1035 or be a resource ID.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"zone": {
+"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getVersion",
+"request": {
+"$ref": "ReservationSlotsGetVersionRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
"list": {
"description": "Retrieves a list of reservation slots under a single reservation.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots",
@@ -41272,6 +41467,62 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+},
+"update": {
+"description": "Update a reservation slot in the specified sub-block.",
+"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}",
+"httpMethod": "POST",
+"id": "compute.reservationSlots.update",
+"parameterOrder": [
+"project",
+"zone",
+"parentName",
+"reservationSlot"
+],
+"parameters": {
+"parentName": {
+"description": "The name of the sub-block resource.",
+"location": "path",
+"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "The project ID for this request.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"reservationSlot": {
+"description": "The name of the slot resource.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "The fields to be updated as part of this request.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+},
+"zone": {
+"description": "The name of the zone for this request, formatted as RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}",
+"request": {
+"$ref": "ReservationSlot"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
}
}
},
@@ -41339,6 +41590,60 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
+"getVersion": {
+"description": "Allows customers to get SBOM versions of a reservation subBlock.",
+"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion",
+"httpMethod": "POST",
+"id": "compute.reservationSubBlocks.getVersion",
+"parameterOrder": [
+"project",
+"zone",
+"parentName",
+"reservationSubBlock"
+],
+"parameters": {
+"parentName": {
+"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"reservationSubBlock": {
+"description": "The name of the reservation subBlock.\nName should conform to RFC1035 or be a resource ID.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"zone": {
+"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion",
+"request": {
+"$ref": "ReservationSubBlocksGetVersionRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
"list": {
"description": "Retrieves a list of reservation subBlocks under a single reservation.",
"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks",
@@ -42885,6 +43190,94 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
+},
+"pause": {
+"description": "Pauses a Rollout.",
+"flatPath": "projects/{project}/global/rollouts/{rollout}/pause",
+"httpMethod": "POST",
+"id": "compute.rollouts.pause",
+"parameterOrder": [
+"project",
+"rollout"
+],
+"parameters": {
+"etag": {
+"description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.",
+"location": "query",
+"type": "string"
+},
+"project": {
+"description": "Required. Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"rollout": {
+"description": "Required. Name of the Rollout resource to pause.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rollouts/{rollout}/pause",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"resume": {
+"description": "Resumes a Rollout.",
+"flatPath": "projects/{project}/global/rollouts/{rollout}/resume",
+"httpMethod": "POST",
+"id": "compute.rollouts.resume",
+"parameterOrder": [
+"project",
+"rollout"
+],
+"parameters": {
+"etag": {
+"description": "The etag of the Rollout.\nIf this is provided, the request will only succeed if the etag matches\nthe current etag of the Rollout.",
+"location": "query",
+"type": "string"
+},
+"project": {
+"description": "Required. Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"rollout": {
+"description": "Required. Name of the Rollout resource to resume.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rollouts/{rollout}/resume",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
}
}
},
@@ -54266,7 +54659,7 @@
}
}
},
-"revision": "20260122",
+"revision": "20260206",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
@@ -55744,6 +56137,7 @@
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P",
+"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X"
],
"enumDescriptions": [
@@ -55754,6 +56148,7 @@
"",
"",
"",
+"",
""
],
"type": "string"
@@ -55939,7 +56334,7 @@
"type": "object"
},
"AllocationSpecificSKUAllocationReservedInstanceProperties": {
-"description": "Properties of the SKU instances being reserved.\nNext ID: 9",
+"description": "Properties of the SKU instances being reserved.\nNext ID: 10",
"id": "AllocationSpecificSKUAllocationReservedInstanceProperties",
"properties": {
"guestAccelerators": {
@@ -57372,6 +57767,10 @@
"format": "float",
"type": "number"
},
+"orchestrationInfo": {
+"$ref": "BackendBackendOrchestrationInfo",
+"description": "Information about the resource or system that manages the backend."
+},
"preference": {
"description": "This field indicates whether this backend should be fully utilized before\nsending traffic to backends with default preference. The possible values\nare:\n \n - PREFERRED: Backends with this preference level will be\n filled up to their capacity limits first, based on RTT.\n - DEFAULT: If preferred backends don't have enough\n capacity, backends in this layer would be used and traffic would be\n assigned based on the load balancing algorithm you use. This is the\n default",
"enum": [
@@ -57406,6 +57805,17 @@
},
"type": "object"
},
+"BackendBackendOrchestrationInfo": {
+"description": "A message containing information about the resource or system that manages\nthe backend.",
+"id": "BackendBackendOrchestrationInfo",
+"properties": {
+"resourceUri": {
+"description": "The URI of the resource or system that manages the backend.",
+"type": "string"
+}
+},
+"type": "object"
+},
"BackendBucket": {
"description": "Represents a Cloud Storage Bucket resource.\n\nThis Cloud Storage bucket resource is referenced by a URL map of a load\nbalancer. For more information, readBackend Buckets.",
"id": "BackendBucket",
@@ -58540,6 +58950,10 @@
"$ref": "BackendServiceNetworkPassThroughLbTrafficPolicy",
"description": "Configures traffic steering properties of internal passthrough Network\nLoad Balancers.\n\nnetworkPassThroughLbTrafficPolicy cannot be specified with haPolicy."
},
+"orchestrationInfo": {
+"$ref": "BackendServiceOrchestrationInfo",
+"description": "Information about the resource or system that manages the backend service."
+},
"outlierDetection": {
"$ref": "OutlierDetection",
"description": "Settings controlling the ejection of unhealthy backend endpoints from the\nload balancing pool of each individual proxy instance that processes the\ntraffic for the given backend service. If not set, this feature is\nconsidered disabled.\n\nResults of the outlier detection algorithm (ejection of endpoints from the\nload balancing pool and returning them back to the pool) are executed\nindependently by each proxy instance of the load balancer. In most cases,\nmore than one proxy instance handles the traffic received by a backend\nservice. Thus, it is possible that an unhealthy endpoint is detected and\nejected by only some of the proxies, and while this happens, other proxies\nmay continue to send requests to the same unhealthy endpoint until they\ndetect and eject the unhealthy endpoint.\n\nApplicable backend endpoints can be:\n \n - VM instances in an Instance Group\n - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)\n - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)\n - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud\n Functions Services \n - Private Service Connect NEGs, that resolve to\n Google-managed regional API endpoints or managed services published using\n Private Service Connect\n\n\n\nApplicable backend service types can be:\n \n - A global backend service with the loadBalancingScheme set to\n INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. \n - A regional backend\n service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and\n loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not\n supported for Serverless NEGs.\n\n\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true."
@@ -59693,6 +60107,17 @@
},
"type": "object"
},
+"BackendServiceOrchestrationInfo": {
+"description": "A message containing information about the resource or system that manages\nthe backend service.",
+"id": "BackendServiceOrchestrationInfo",
+"properties": {
+"resourceUri": {
+"description": "The resource URI of the resource or system that manages the backend\nservice.",
+"type": "string"
+}
+},
+"type": "object"
+},
"BackendServiceParams": {
"description": "Additional Backend Service parameters.",
"id": "BackendServiceParams",
@@ -60848,6 +61273,11 @@
"description": "Defines the instance scheduling options.",
"id": "CapacityAdviceRequestInstancePropertiesScheduling",
"properties": {
+"maxRunDuration": {
+"description": "The maximum time that instances can run before Compute Engine\nterminates them.",
+"format": "google-duration",
+"type": "string"
+},
"provisioningModel": {
"description": "Specifies the provisioning model of the instance.",
"enum": [
@@ -60905,6 +61335,12 @@
"format": "google-duration",
"type": "string"
},
+"estimatedWaitDuration": {
+"description": "Output only. The likely maximum time that you will have to wait until\nCompute Engine provisions your instances.",
+"format": "google-duration",
+"readOnly": true,
+"type": "string"
+},
"obtainability": {
"description": "The obtainability score indicates the likelihood of successfully\nobtaining (provisioning) the requested number of VMs.\nThe score range is 0.0 through 1.0. Higher is better.",
"format": "double",
@@ -62048,6 +62484,40 @@
},
"type": "object"
},
+"CompositeHealthCheckHealth": {
+"description": "Response message for RegionCompositeHealthChecks.GetHealth",
+"id": "CompositeHealthCheckHealth",
+"properties": {
+"healthSources": {
+"description": "Health sources and their corresponding health states.",
+"items": {
+"$ref": "CompositeHealthChecksGetHealthResponseHealthSourceHealth"
+},
+"type": "array"
+},
+"healthState": {
+"description": "Health state of the CompositeHealthCheck.",
+"enum": [
+"HEALTHY",
+"UNHEALTHY",
+"UNKNOWN"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"kind": {
+"default": "compute#compositeHealthCheckHealth",
+"description": "Output only. [Output Only] Type of resource. Alwayscompute#compositeHealthCheckHealth for the health of\ncomposite health checks.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
"CompositeHealthCheckList": {
"id": "CompositeHealthCheckList",
"properties": {
@@ -62203,34 +62673,6 @@
},
"type": "object"
},
-"CompositeHealthChecksGetHealthResponse": {
-"description": "Response message for RegionCompositeHealthChecks.GetHealth",
-"id": "CompositeHealthChecksGetHealthResponse",
-"properties": {
-"healthSources": {
-"description": "Health sources and their corresponding health states.",
-"items": {
-"$ref": "CompositeHealthChecksGetHealthResponseHealthSourceHealth"
-},
-"type": "array"
-},
-"healthState": {
-"description": "Health state of the CompositeHealthCheck.",
-"enum": [
-"HEALTHY",
-"UNHEALTHY",
-"UNKNOWN"
-],
-"enumDescriptions": [
-"",
-"",
-""
-],
-"type": "string"
-}
-},
-"type": "object"
-},
"CompositeHealthChecksGetHealthResponseHealthSourceHealth": {
"id": "CompositeHealthChecksGetHealthResponseHealthSourceHealth",
"properties": {
@@ -62249,7 +62691,7 @@
"type": "string"
},
"source": {
-"description": "URL of the associated HealthSource resource.",
+"description": "Fully qualified URL of the associated HealthSource resource.",
"type": "string"
}
},
@@ -62875,6 +63317,57 @@
},
"type": "object"
},
+"DateTime": {
+"description": "Represents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n * When utc_offset is set and time_zone is unset: a civil time on a calendar\n day with a particular offset from UTC.\n * When time_zone is set and utc_offset is unset: a civil time on a calendar\n day in a particular time zone.\n * When neither time_zone nor utc_offset is set: a civil time on a calendar\n day in local time.\n\nThe date is relative to the Proleptic Gregorian Calendar.\n\nIf year, month, or day are 0, the DateTime is considered not to have a\nspecific year, month, or day respectively.\n\nThis type may also be used to represent a physical time if all the date and\ntime fields are set and either case of the `time_offset` oneof is set.\nConsider using `Timestamp` message for physical time instead. If your use\ncase also would like to store the user's timezone, that can be done in\nanother field.\n\nThis type is more flexible than some applications may want. Make sure to\ndocument and validate your application's limitations.",
+"id": "DateTime",
+"properties": {
+"day": {
+"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and\nmonth, or 0 if specifying a datetime without a day.",
+"format": "int32",
+"type": "integer"
+},
+"hours": {
+"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults\nto 0 (midnight). An API may choose to allow the value \"24:00:00\" for\nscenarios like business closing time.",
+"format": "int32",
+"type": "integer"
+},
+"minutes": {
+"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.",
+"format": "int32",
+"type": "integer"
+},
+"month": {
+"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a\ndatetime without a month.",
+"format": "int32",
+"type": "integer"
+},
+"nanos": {
+"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999, defaults to 0.",
+"format": "int32",
+"type": "integer"
+},
+"seconds": {
+"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59,\ndefaults to 0. An API may allow the value 60 if it allows leap-seconds.",
+"format": "int32",
+"type": "integer"
+},
+"timeZone": {
+"$ref": "TimeZone",
+"description": "Time zone."
+},
+"utcOffset": {
+"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours.\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }.",
+"format": "google-duration",
+"type": "string"
+},
+"year": {
+"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
"DeprecationStatus": {
"description": "Deprecation status for a public resource.",
"id": "DeprecationStatus",
@@ -63487,6 +63980,32 @@
},
"type": "object"
},
+"DiskConvertParams": {
+"id": "DiskConvertParams",
+"properties": {
+"forceStopInProgressSnapshot": {
+"type": "boolean"
+},
+"provisionedIops": {
+"format": "int64",
+"type": "string"
+},
+"provisionedThroughput": {
+"format": "int64",
+"type": "string"
+},
+"quickConversionOnly": {
+"type": "boolean"
+},
+"resetSupportedVmFamilies": {
+"type": "boolean"
+},
+"targetDiskType": {
+"type": "string"
+}
+},
+"type": "object"
+},
"DiskInstantiationConfig": {
"description": "A specification of the desired way to instantiate a disk in the instance\ntemplate when its created from a source instance.",
"id": "DiskInstantiationConfig",
@@ -64404,6 +64923,15 @@
},
"type": "object"
},
+"DisksConvertRequest": {
+"id": "DisksConvertRequest",
+"properties": {
+"params": {
+"$ref": "DiskConvertParams"
+}
+},
+"type": "object"
+},
"DisksRemoveResourcePoliciesRequest": {
"id": "DisksRemoveResourcePoliciesRequest",
"properties": {
@@ -67377,6 +67905,10 @@
"FutureReservation": {
"id": "FutureReservation",
"properties": {
+"advancedDeploymentControl": {
+"$ref": "ReservationAdvancedDeploymentControl",
+"description": "Advanced control for cluster management, applicable only to DENSE\ndeployment type future reservations."
+},
"aggregateReservation": {
"$ref": "AllocationAggregateReservation",
"description": "Aggregate reservation details for the future reservation."
@@ -67397,6 +67929,17 @@
"$ref": "FutureReservationCommitmentInfo",
"description": "If not present, then FR will not deliver a new commitment or update an\nexisting commitment."
},
+"confidentialComputeType": {
+"enum": [
+"CONFIDENTIAL_COMPUTE_TYPE_TDX",
+"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED"
+],
+"enumDescriptions": [
+"Intel Trust Domain Extensions.",
+""
+],
+"type": "string"
+},
"creationTimestamp": {
"description": "Output only. [Output Only] The creation timestamp for this future reservation inRFC3339\ntext format.",
"readOnly": true,
@@ -68427,6 +68970,7 @@
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P",
+"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X"
],
"enumDescriptions": [
@@ -68437,6 +68981,7 @@
"",
"",
"",
+"",
""
],
"type": "string"
@@ -68638,6 +69183,35 @@
},
"type": "object"
},
+"GetVersionOperationMetadata": {
+"id": "GetVersionOperationMetadata",
+"properties": {
+"inlineSbomInfo": {
+"$ref": "GetVersionOperationMetadataSbomInfo"
+}
+},
+"type": "object"
+},
+"GetVersionOperationMetadataSbomInfo": {
+"id": "GetVersionOperationMetadataSbomInfo",
+"properties": {
+"currentComponentVersions": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "SBOM versions currently applied to the resource. The key is the component\nname and the value is the version.",
+"type": "object"
+},
+"targetComponentVersions": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "SBOM versions scheduled for the next maintenance. The key is the\ncomponent name and the value is the version.",
+"type": "object"
+}
+},
+"type": "object"
+},
"GlobalAddressesMoveRequest": {
"id": "GlobalAddressesMoveRequest",
"properties": {
@@ -69719,7 +70293,7 @@
"id": "HaController",
"properties": {
"backendServices": {
-"description": "Advanced configuration option. If specified, these Backend Services need to\nbe pre-created and configured as managed.",
+"description": "Advanced configuration option. If specified, these Backend Services need to\nbe pre-created.\n\nCurrently, only one backend service can be specified, and it must be L4\nInternal Load Balancer (ILB).",
"items": {
"type": "string"
},
@@ -72617,6 +73191,40 @@
},
"type": "object"
},
+"HealthSourceHealth": {
+"description": "Response message for RegionHealthSources.GetHealth",
+"id": "HealthSourceHealth",
+"properties": {
+"healthState": {
+"description": "Health state of the HealthSource.",
+"enum": [
+"HEALTHY",
+"UNHEALTHY",
+"UNKNOWN"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"kind": {
+"default": "compute#healthSourceHealth",
+"description": "Output only. [Output Only] Type of resource. Alwayscompute#healthSourceHealth for the health of health sources.",
+"readOnly": true,
+"type": "string"
+},
+"sources": {
+"description": "Health state details of the sources.",
+"items": {
+"$ref": "HealthSourcesGetHealthResponseSourceInfo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"HealthSourceList": {
"id": "HealthSourceList",
"properties": {
@@ -72772,6 +73380,47 @@
},
"type": "object"
},
+"HealthSourcesGetHealthResponseSourceInfo": {
+"id": "HealthSourcesGetHealthResponseSourceInfo",
+"properties": {
+"backends": {
+"description": "Represents an instance group or network endpoint group behind the source\nbackend service. Only used if the sourceType of the regionHealthSource\nis BACKEND_SERVICE.",
+"items": {
+"$ref": "HealthSourcesGetHealthResponseSourceInfoBackendInfo"
+},
+"type": "array"
+},
+"forwardingRule": {
+"description": "Fully qualified URL of the forwarding rule associated with the source\nresource if it is a L4ILB backend service.",
+"type": "string"
+},
+"source": {
+"description": "Fully qualified URL of the associated source resource. This is always a\nbackend service URL.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"HealthSourcesGetHealthResponseSourceInfoBackendInfo": {
+"id": "HealthSourcesGetHealthResponseSourceInfoBackendInfo",
+"properties": {
+"endpointCount": {
+"description": "Total number of endpoints when determining the health of the\nregionHealthSource.",
+"format": "int32",
+"type": "integer"
+},
+"group": {
+"description": "Fully qualified URL of an instance group or network endpoint group\nbehind the source backend service.",
+"type": "string"
+},
+"healthyEndpointCount": {
+"description": "Number of endpoints considered healthy when determining health of the\nregionHealthSource.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
"HealthSourcesScopedList": {
"id": "HealthSourcesScopedList",
"properties": {
@@ -75741,6 +76390,12 @@
"readOnly": true,
"type": "integer"
},
+"restartingInPlace": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group that\nare scheduled to be restarted or are currently being restarted.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
"resuming": {
"description": "Output only. [Output Only] The number of instances in the managed instance group that\nare scheduled to be resumed or are currently being resumed.",
"format": "int32",
@@ -77156,6 +77811,18 @@
"InstanceGroupManagerUpdatePolicy": {
"id": "InstanceGroupManagerUpdatePolicy",
"properties": {
+"disruptionMode": {
+"description": "Whether the boot disk is allowed to be updated with restart.",
+"enum": [
+"LEGACY",
+"OPTIMIZED"
+],
+"enumDescriptions": [
+"Default option: boot disk will not be updated with restart.",
+"Boot disk will be updated with restart."
+],
+"type": "string"
+},
"instanceRedistributionType": {
"description": "The \ninstance redistribution policy for regional managed instance groups.\nValid values are: \n \n - PROACTIVE (default): The group attempts to maintain an\n even distribution of VM instances across zones in the region.\n - NONE: For non-autoscaled groups, proactive\n redistribution is disabled.",
"enum": [
@@ -77187,13 +77854,15 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
},
@@ -77203,13 +77872,15 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
},
@@ -77283,6 +77954,18 @@
"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.",
"type": "boolean"
},
+"disruptionMode": {
+"description": "Whether the boot disk is allowed to be updated with restart.",
+"enum": [
+"LEGACY",
+"OPTIMIZED"
+],
+"enumDescriptions": [
+"Default option: boot disk will not be updated with restart.",
+"Boot disk will be updated with restart."
+],
+"type": "string"
+},
"instances": {
"description": "The list of URLs of one or more instances for which you want to apply\nupdates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
@@ -77296,13 +77979,15 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
},
@@ -77312,13 +77997,15 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
},
@@ -77328,19 +78015,45 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
}
},
"type": "object"
},
+"InstanceGroupManagersConfigureAcceleratorTopologiesRequest": {
+"description": "InstanceGroupManagers.ConfigureAcceleratorTopologies",
+"id": "InstanceGroupManagersConfigureAcceleratorTopologiesRequest",
+"properties": {
+"acceleratorTopologyActions": {
+"additionalProperties": {
+"enum": [
+"ACCELERATOR_TOPOLOGY_ACTION_UNSPECIFIED",
+"ACTIVATE",
+"DEACTIVATE"
+],
+"enumDescriptions": [
+"Default value. Should not be used.",
+"The accelerator topology is to be activated.",
+"The accelerator topology is to be deactivated."
+],
+"type": "string"
+},
+"description": "Map of accelerator topologies that should have their state changed to\nthe specified value. The key is the hashed topology locus id. It can be\nobtained from the GetAvailableAcceleratorTopologies rpc.",
+"type": "object"
+}
+},
+"type": "object"
+},
"InstanceGroupManagersCreateInstancesRequest": {
"description": "InstanceGroupManagers.createInstances",
"id": "InstanceGroupManagersCreateInstancesRequest",
@@ -77402,6 +78115,10 @@
},
"description": "The accelerator topology information returned per id of the topology\nlocation.",
"type": "object"
+},
+"multiMig": {
+"description": "URL to MMIG this MIG belongs to.",
+"type": "string"
}
},
"type": "object"
@@ -77417,14 +78134,115 @@
"enum": [
"DEGRADED",
"HEALTHY",
-"UNHEALTHY"
+"UNHEALTHY",
+"UNKNOWN"
],
"enumDescriptions": [
"All VM are in RUNNING state, but there is an issue with\nthe inter-chip connectivity that makes this part\nof the infrastructure ready to use as a working\ninter-chip connected group only in a degraded mode.\nThis is allowed only for Instances configured with ICI\nresiliency",
"All VM are in RUNNING state, there are no issues with the\ninter-chip connectivity.",
-"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group."
+"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group.",
+"No signal available"
],
"type": "string"
+},
+"acceleratorTopologyState": {
+"$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState"
+},
+"instancesHealth": {
+"enum": [
+"ALL_HEALTHY",
+"UNHEALTHY_OR_MISSING"
+],
+"enumDescriptions": [
+"Infrastructure is healthy",
+"Some VMs are in another state than RUNNING or they are missing."
+],
+"type": "string"
+},
+"parent": {
+"description": "Identified by the topology Id in the accelerator_topology_info map. Empty\nfor the top-level topology",
+"type": "string"
+}
+},
+"type": "object"
+},
+"InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState": {
+"description": "Specifies the topology state",
+"id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState",
+"properties": {
+"currentState": {
+"enum": [
+"ACTIVATING",
+"ACTIVE",
+"ACTIVE_DEGRADED",
+"DEACTIVATING",
+"FAILED",
+"INACTIVE",
+"INCOMPLETE"
+],
+"enumDescriptions": [
+"",
+"",
+"The topology is active but with potential performance degradation.",
+"",
+"Critical non-retriable error that the user has to act manually",
+"",
+"Not all VMs have been provisioned"
+],
+"type": "string"
+},
+"error": {
+"description": "Reason why the topology state change failed",
+"properties": {
+"errors": {
+"description": "[Output Only] The array of errors encountered while processing this\noperation.",
+"items": {
+"properties": {
+"code": {
+"description": "[Output Only] The error type identifier for this error.",
+"type": "string"
+},
+"errorDetails": {
+"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.",
+"items": {
+"properties": {
+"errorInfo": {
+"$ref": "ErrorInfo"
+},
+"help": {
+"$ref": "Help"
+},
+"localizedMessage": {
+"$ref": "LocalizedMessage"
+},
+"quotaInfo": {
+"$ref": "QuotaExceededInfo"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"location": {
+"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.",
+"type": "string"
+},
+"message": {
+"description": "[Output Only] An optional, human-readable error message.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"errorTimestamp": {
+"description": "Timestamp when the last error happened",
+"format": "google-datetime",
+"type": "string"
}
},
"type": "object"
@@ -81055,7 +81873,7 @@
"type": "string"
},
"subzone": {
-"description": "Specific subzone in the InterconnectLocation that represents where\nthis connection is to be provisioned.",
+"description": "To be deprecated.",
"enum": [
"SUBZONE_A",
"SUBZONE_B"
@@ -89928,7 +90746,7 @@
"type": "object"
},
"NetworkEndpointGroup": {
-"description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be\nreached, whether they are reachable, and where they are located.\nFor more information about using NEGs for different use cases, seeNetwork endpoint groups overview.",
+"description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be\nreached, whether they are reachable, and where they are located.\nFor more information about using NEGs for different use cases, seeNetwork endpoint groups overview.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"id": "NetworkEndpointGroup",
"properties": {
"annotations": {
@@ -96147,6 +96965,9 @@
},
"type": "object"
},
+"getVersionOperationMetadata": {
+"$ref": "GetVersionOperationMetadata"
+},
"httpErrorMessage": {
"description": "[Output Only] If the operation fails, this field contains the HTTP error\nmessage that was returned, such as `NOT FOUND`.",
"type": "string"
@@ -97803,6 +98624,54 @@
},
"type": "object"
},
+"PeriodicPartialMaintenanceSchedule": {
+"description": "The periodic partial maintenance schedule includes 52 weeks worth of\nmaintenance windows.\nLINT.IfChange(PeriodicPartialMaintenanceSchedule)",
+"id": "PeriodicPartialMaintenanceSchedule",
+"properties": {
+"subType": {
+"description": "The maintenance type in which the zone is during the given window.",
+"enum": [
+"MAINTENANCE_SUBTYPE_UNSPECIFIED",
+"MAINTENANCE_TYPE_CUSTOMER_MAINTENANCE",
+"MAINTENANCE_TYPE_DISRUPTIVE_UPGRADE",
+"MAINTENANCE_TYPE_STABLE",
+"MAINTENANCE_TYPE_TRANSITION"
+],
+"enumDescriptions": [
+"Default value.",
+"A dedicated window for customers to perform their own maintenance. This\noften runs concurrently with a DISRUPTIVE_UPGRADE. This corresponds to\nthe Customer Maintenance Window for CME.",
+"For disruptive updates, including host machine kernel or firmware\nupgrades. This corresponds to the Critical Services Maintenance Window\nfor CME.",
+"A post-maintenance window for customers to conduct final testing and\nperformance validation before resuming full business operations. This\ncorresponds to Performance Stress Testing for CME.",
+"For preliminary, non-disruptive tasks such as key rotations. This\ncorresponds to the Zone Swap Window for CME."
+],
+"type": "string"
+},
+"targetResource": {
+"description": "The target resource that the maintenance window is for.\nFor example, \"projects/my-project/zones/us-central1-a\".",
+"type": "string"
+},
+"type": {
+"enum": [
+"MAINTENANCE_TYPE_UNSPECIFIED",
+"PRIVATE_ZONE_MAINTENANCE"
+],
+"enumDescriptions": [
+"Default value.",
+"The zone is in a private maintenance window."
+],
+"type": "string"
+},
+"windowEndTime": {
+"$ref": "DateTime",
+"description": "The end civil timestamp of the window (not inclusive).\nThis contains a time zone."
+},
+"windowStartTime": {
+"$ref": "DateTime",
+"description": "The start civil timestamp of the window.\nThis contains a time zone."
+}
+},
+"type": "object"
+},
"Permission": {
"description": "[Deprecated] All fields defined in a permission are ANDed.",
"id": "Permission",
@@ -102804,6 +103673,18 @@
"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.",
"type": "boolean"
},
+"disruptionMode": {
+"description": "Whether the boot disk is allowed to be updated with restart.",
+"enum": [
+"LEGACY",
+"OPTIMIZED"
+],
+"enumDescriptions": [
+"Default option: boot disk will not be updated with restart.",
+"Boot disk will be updated with restart."
+],
+"type": "string"
+},
"instances": {
"description": "The list of URLs of one or more instances for which you want to apply\nupdates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
@@ -102817,13 +103698,15 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
},
@@ -102833,13 +103716,15 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
},
@@ -102849,13 +103734,15 @@
"NONE",
"REFRESH",
"REPLACE",
-"RESTART"
+"RESTART",
+"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
-"Stop the instance and start it again."
+"Stop the instance and start it again.",
+"Restart the instance using the same capacity and preserving local SSDs."
],
"type": "string"
}
@@ -104015,6 +104902,17 @@
"readOnly": true,
"type": "string"
},
+"confidentialComputeType": {
+"enum": [
+"CONFIDENTIAL_COMPUTE_TYPE_TDX",
+"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED"
+],
+"enumDescriptions": [
+"Intel Trust Domain Extensions.",
+""
+],
+"type": "string"
+},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
@@ -104046,6 +104944,20 @@
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
+"earlyAccessMaintenance": {
+"description": "Indicates the early access maintenance for the reservation.\nIf this field is absent or set to NO_EARLY_ACCESS, the reservation is not\nenrolled in early access maintenance and the standard notice applies.",
+"enum": [
+"NO_EARLY_ACCESS",
+"WAVE1",
+"WAVE2"
+],
+"enumDescriptions": [
+"No early access.",
+"Wave 1: Fastest notification period",
+"Wave 2: Medium notification period"
+],
+"type": "string"
+},
"enableEmergentMaintenance": {
"description": "Indicates whether Compute Engine allows unplanned maintenance for your VMs;\nfor example, to fix hardware errors.",
"type": "boolean"
@@ -105093,6 +106005,29 @@
},
"type": "object"
},
+"ReservationSlotsGetVersionRequest": {
+"id": "ReservationSlotsGetVersionRequest",
+"properties": {
+"sbomSelections": {
+"description": "The SBOM selection to return. Duplicate values in the list will be ignored.",
+"items": {
+"enum": [
+"SBOM_SELECTION_CURRENT",
+"SBOM_SELECTION_TARGET",
+"SBOM_SELECTION_UNSPECIFIED"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"ReservationSlotsListResponse": {
"description": "A list of reservation slots within a single reservation.",
"id": "ReservationSlotsListResponse",
@@ -105415,6 +106350,29 @@
},
"type": "object"
},
+"ReservationSubBlocksGetVersionRequest": {
+"id": "ReservationSubBlocksGetVersionRequest",
+"properties": {
+"sbomSelections": {
+"description": "The SBOM selection to return.",
+"items": {
+"enum": [
+"SBOM_SELECTION_CURRENT",
+"SBOM_SELECTION_TARGET",
+"SBOM_SELECTION_UNSPECIFIED"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"ReservationSubBlocksListResponse": {
"description": "A list of reservation subBlocks under a single reservation.",
"id": "ReservationSubBlocksListResponse",
@@ -107030,6 +107988,10 @@
"description": "Effective enable-oslogin value at Instance level.",
"type": "boolean"
},
+"gceContainerDeclarationMetadataValue": {
+"description": "Effective gce-container-declaration value at Instance level.",
+"type": "boolean"
+},
"serialPortEnableMetadataValue": {
"description": "Effective serial-port-enable value at Instance level.",
"type": "boolean"
@@ -108281,12 +109243,16 @@
"ACTIVE",
"DROPPED",
"INACTIVE",
+"OVERRIDDEN_BY_HUB",
+"OVERRIDDEN_BY_PEERING",
"PENDING"
],
"enumDescriptions": [
"This route is processed and active.",
"The route is dropped due to the VPC exceeding the dynamic route limit.\n For dynamic route limit, please refer to the\nLearned route example",
"This route is processed but inactive due to failure from the backend. The\nbackend may have rejected the route",
+"For an Arcus VPC Peering route, this state indicates that the route is\ninactive because a corresponding Network Connectivity Center (NCC) route\nhas taken precedence.",
+"For a Network Connectivity Center (NCC) route, this state indicates that\nthe route is inactive because a corresponding Arcus VPC Peering route\nhas taken precedence.",
"This route is being processed internally. The status will change once\nprocessed."
],
"type": "string"
@@ -116472,6 +117438,20 @@
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
+"postQuantumKeyExchange": {
+"description": "One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer allows\nnegotiating X25519MLKEM768 key exchange when clients advertise support for\nit. When set to DEFAULT, or if no SSL Policy is\nattached to the target proxy, the load balancer disallows X25519MLKEM768\nkey exchange until it is enabled by default on LBs. When set toENABLED, the load balancer will negotiate X25519MLKEM768 key\nexchange. Customers can set this to DEFERRED to temporarily\nopt-out the LB from negotiating post-quantum key exchange by default.",
+"enum": [
+"DEFAULT",
+"DEFERRED",
+"ENABLED"
+],
+"enumDescriptions": [
+"Post-quantum key exchange is disabled until it becomes enabled by\ndefault on LBs.",
+"Post-quantum key exchange with clients is temporarily disabled.",
+"Post-quantum key exchange is enabled."
+],
+"type": "string"
+},
"profile": {
"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED, orCUSTOM. If using CUSTOM, the set of SSL features\nto enable must be specified in the customFeatures field.",
"enum": [
@@ -123545,6 +124525,21 @@
},
"type": "object"
},
+"TimeZone": {
+"description": "Represents a time zone from the\n[IANA Time Zone Database](https://www.iana.org/time-zones).",
+"id": "TimeZone",
+"properties": {
+"id": {
+"description": "IANA Time Zone Database time zone. For example \"America/New_York\".",
+"type": "string"
+},
+"version": {
+"description": "Optional. IANA Time Zone Database version number. For example \"2019a\".",
+"type": "string"
+}
+},
+"type": "object"
+},
"TlsCertificateContext": {
"description": "[Deprecated] Defines the mechanism to obtain the client or server\ncertificate.\nDefines the mechanism to obtain the client or server certificate.",
"id": "TlsCertificateContext",
@@ -127989,6 +128984,10 @@
"description": "[Output Only] Full URL reference to the region which hosts the zone.",
"type": "string"
},
+"resourceStatus": {
+"$ref": "ZoneResourceStatus",
+"readOnly": true
+},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
@@ -128170,6 +129169,20 @@
},
"type": "object"
},
+"ZoneResourceStatus": {
+"id": "ZoneResourceStatus",
+"properties": {
+"upcomingMaintenances": {
+"description": "Output only. [Output Only] The upcoming maintenance schedule.",
+"items": {
+"$ref": "PeriodicPartialMaintenanceSchedule"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
"ZoneSetLabelsRequest": {
"id": "ZoneSetLabelsRequest",
"properties": {
diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json
index efeead0..083601d 100644
--- a/googleapiclient/discovery_cache/documents/compute.beta.json
+++ b/googleapiclient/discovery_cache/documents/compute.beta.json
@@ -6822,7 +6822,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/global/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.insert",
@@ -19294,7 +19294,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.insert",
@@ -32826,7 +32826,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.regionNetworkEndpointGroups.insert",
@@ -50445,7 +50445,7 @@
}
}
},
-"revision": "20260122",
+"revision": "20260206",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
@@ -52055,7 +52055,7 @@
"type": "object"
},
"AllocationSpecificSKUAllocationReservedInstanceProperties": {
-"description": "Properties of the SKU instances being reserved.\nNext ID: 9",
+"description": "Properties of the SKU instances being reserved.\nNext ID: 10",
"id": "AllocationSpecificSKUAllocationReservedInstanceProperties",
"properties": {
"guestAccelerators": {
@@ -56427,6 +56427,132 @@
},
"type": "object"
},
+"CachePolicy": {
+"description": "Message containing CachePolicy configuration for URL Map's Route Action.",
+"id": "CachePolicy",
+"properties": {
+"cacheBypassRequestHeaderNames": {
+"description": "Bypass the cache when the specified request headers are matched by name,\ne.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5\nheader names can be specified. The cache is bypassed for all\ncachePolicy.cacheMode settings.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"cacheKeyPolicy": {
+"$ref": "CachePolicyCacheKeyPolicy",
+"description": "The CacheKeyPolicy for this CachePolicy."
+},
+"cacheMode": {
+"description": "Specifies the cache setting for all responses from this route.\nIf not specified, the default value is CACHE_ALL_STATIC.",
+"enum": [
+"CACHE_ALL_STATIC",
+"FORCE_CACHE_ALL",
+"USE_ORIGIN_HEADERS"
+],
+"enumDescriptions": [
+"Automatically cache static content, including common image formats,\nmedia (video and audio), and web assets (JavaScript and CSS).\nRequests and responses that are marked as uncacheable, as well as\ndynamic content (including HTML), will not be cached.",
+"Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\"\ndirectives in Cache-Control response headers.\nWarning: this may result in Cloud CDN caching private,\nper-user (user identifiable) content.",
+"Requires the origin to set valid caching headers to cache content.\nResponses without these headers will not be cached at the edge, and will\nrequire a full trip to the origin on every request, potentially impacting\nperformance and increasing load on the origin server."
+],
+"type": "string"
+},
+"clientTtl": {
+"$ref": "Duration",
+"description": "Specifies a separate client (e.g. browser client) maximum TTL. This is\nused to clamp the max-age (or Expires) value sent to the client. With\nFORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the\nresponse max-age directive, along with a \"public\" directive. For\ncacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age\nfrom the origin (if specified), or else sets the response max-age\ndirective to the lesser of the client_ttl and default_ttl, and also\nensures a \"public\" cache-control directive is present.\nIf a client TTL is not specified, a default value (1 hour) will be used.\nThe maximum allowed value is 31,622,400s (1 year)."
+},
+"defaultTtl": {
+"$ref": "Duration",
+"description": "Specifies the default TTL for cached content served by this origin for\nresponses that do not have an existing valid TTL (max-age or s-maxage).\nSetting a TTL of \"0\" means \"always revalidate\".\nThe value of defaultTTL cannot be set to a value greater than that of\nmaxTTL.\nWhen the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL\nwill overwrite the TTL set in all responses. The maximum allowed value is\n31,622,400s (1 year). Infrequently accessed objects may be evicted from\nthe cache before the defined TTL."
+},
+"maxTtl": {
+"$ref": "Duration",
+"description": "Specifies the maximum allowed TTL for cached content served by this\norigin.\nCache directives that attempt to set a max-age or s-maxage higher than\nthis, or an Expires header more than maxTTL seconds in the future will\nbe capped at the value of maxTTL, as if it were the value of an\ns-maxage Cache-Control directive.\nHeaders sent to the client will not be modified.\nSetting a TTL of \"0\" means \"always revalidate\".\nThe maximum allowed value is 31,622,400s (1 year). Infrequently accessed\nobjects may be evicted from the cache before the defined TTL."
+},
+"negativeCaching": {
+"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,\nnegative caching applies to responses with the specified response code\nthat lack any Cache-Control, Expires, or Pragma: no-cache directives.\nWhen the cache mode is set to FORCE_CACHE_ALL, negative caching applies\nto all responses with the specified response code, and override any\ncaching headers.\nBy default, Cloud CDN will apply the following default TTLs to these\nstatus codes:\nHTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\nHTTP 404 (Not Found), 410 (Gone),\n451 (Unavailable For Legal Reasons): 120s\nHTTP 405 (Method Not Found), 501 (Not Implemented): 60s.\nThese defaults can be overridden in negative_caching_policy.",
+"type": "boolean"
+},
+"negativeCachingPolicy": {
+"description": "Sets a cache TTL for the specified HTTP status code.\nnegative_caching must be enabled to configure negative_caching_policy.\nOmitting the policy and leaving negative_caching enabled will use\nCloud CDN's default cache TTLs.\nNote that when specifying an explicit negative_caching_policy, you\nshould take care to specify a cache TTL for all response codes\nthat you wish to cache. Cloud CDN will not apply any default\nnegative caching when a policy exists.",
+"items": {
+"$ref": "CachePolicyNegativeCachingPolicy"
+},
+"type": "array"
+},
+"requestCoalescing": {
+"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin.",
+"type": "boolean"
+},
+"serveWhileStale": {
+"$ref": "Duration",
+"description": "Serve existing content from the cache (if available) when revalidating\ncontent with the origin, or when an error is encountered when refreshing\nthe cache.\nThis setting defines the default \"max-stale\" duration for any cached\nresponses that do not specify a max-stale directive. Stale responses that\nexceed the TTL configured here will not be served. The default limit\n(max-stale) is 86400s (1 day), which will allow stale content to be\nserved up to this limit beyond the max-age (or s-maxage) of a cached\nresponse.\nThe maximum allowed value is 604800 (1 week).\nSet this to zero (0) to disable serve-while-stale."
+}
+},
+"type": "object"
+},
+"CachePolicyCacheKeyPolicy": {
+"description": "Message containing what to include in the cache key for a request for Cache\nPolicy defined on Route Action.",
+"id": "CachePolicyCacheKeyPolicy",
+"properties": {
+"excludedQueryParameters": {
+"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify excluded_query_parameters or\nincluded_query_parameters, not both. '&' and '=' will be percent encoded\nand not treated as delimiters.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use includedQueryParameters to define which parameters should\nbe a part of the cache key.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"includeHost": {
+"description": "If true, requests to different hosts will be cached separately.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket, as the\nhost is never included in a Backend Bucket's cache key. Attempting to set\nit on a route that points exclusively to Backend Buckets will result in a\nconfiguration error.",
+"type": "boolean"
+},
+"includeProtocol": {
+"description": "If true, http and https requests will be cached separately.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket, as the\nprotocol is never included in a Backend Bucket's cache key. Attempting to\nset on a route that points exclusively to Backend Buckets will result in\na configuration error.",
+"type": "boolean"
+},
+"includeQueryString": {
+"description": "If true, include query string parameters in the cache key according to\nincluded_query_parameters and excluded_query_parameters. If neither is\nset, the entire query string will be included. If false, the query string\nwill be excluded from the cache key entirely.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use includedQueryParameters to define which parameters should\nbe a part of the cache key.",
+"type": "boolean"
+},
+"includedCookieNames": {
+"description": "Allows HTTP cookies (by name) to be used in the cache key.\nThe name=value pair will be used in the cache key Cloud CDN generates.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket.\nAttempting to set it on a route that points exclusively to Backend\nBuckets will result in a configuration error. Up to 5 cookie names can be\nspecified.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"includedHeaderNames": {
+"description": "Allows HTTP request headers (by name) to be used in the cache key.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"includedQueryParameters": {
+"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify included_query_parameters or\nexcluded_query_parameters, not both. '&' and '=' will be percent encoded\nand not treated as delimiters.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"CachePolicyNegativeCachingPolicy": {
+"description": "Specify CDN TTLs for response error codes.",
+"id": "CachePolicyNegativeCachingPolicy",
+"properties": {
+"code": {
+"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
+"format": "int32",
+"type": "integer"
+},
+"ttl": {
+"$ref": "Duration",
+"description": "The TTL (in seconds) for which to cache responses with the\ncorresponding status code.\nThe maximum allowed value is 1800s (30 minutes). Infrequently accessed\nobjects may be evicted from the cache before the defined TTL."
+}
+},
+"type": "object"
+},
"CalendarModeAdviceRequest": {
"description": "A request to recommend the best way to consume the specified resources in the\nfuture.",
"id": "CalendarModeAdviceRequest",
@@ -62390,6 +62516,10 @@
"FutureReservation": {
"id": "FutureReservation",
"properties": {
+"advancedDeploymentControl": {
+"$ref": "ReservationAdvancedDeploymentControl",
+"description": "Advanced control for cluster management, applicable only to DENSE\ndeployment type future reservations."
+},
"aggregateReservation": {
"$ref": "AllocationAggregateReservation",
"description": "Aggregate reservation details for the future reservation."
@@ -67037,6 +67167,10 @@
"HttpRouteAction": {
"id": "HttpRouteAction",
"properties": {
+"cachePolicy": {
+"$ref": "CachePolicy",
+"description": "Cache policy for this URL Map\u2019s route. Available only for Global\nEXTERNAL_MANAGED load balancer schemes."
+},
"corsPolicy": {
"$ref": "CorsPolicy",
"description": "The specification for allowing client-side cross-origin requests. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.\n\nNot supported when the URL map is bound to a target gRPC proxy."
@@ -68175,6 +68309,9 @@
"$ref": "Tags",
"description": "Tags to apply to this instance. Tags are used to identify valid\nsources or targets for network firewalls and are specified by the client\nduring instance creation. The tags can be later modified by the setTags\nmethod. Each tag within the list must comply withRFC1035.\nMultiple tags can be specified via the 'tags.items' field."
},
+"workloadIdentityConfig": {
+"$ref": "WorkloadIdentityConfig"
+},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the instance resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
@@ -70086,6 +70223,11 @@
"description": "Output only. [Output Only] The status of bulk instance operation.",
"readOnly": true
},
+"currentInstanceStatuses": {
+"$ref": "InstanceGroupManagerStatusInstanceStatusSummary",
+"description": "Output only. [Output Only] The list of instance statuses and the number of instances\nin this managed instance group that have the status. Currently only shown\nfor TPU MIGs",
+"readOnly": true
+},
"isStable": {
"description": "Output only. [Output Only] A bit indicating whether the managed instance group is in a\nstable state. A stable state means that: none of the instances in the\nmanaged instance group is currently undergoing any type of change (for\nexample, creation, restart, or deletion); no future changes are scheduled\nfor instances in the managed instance group; and the managed instance\ngroup itself is not being modified.",
"readOnly": true,
@@ -70198,6 +70340,91 @@
},
"type": "object"
},
+"InstanceGroupManagerStatusInstanceStatusSummary": {
+"description": "The list of instance statuses and the number of instances in this managed\ninstance group that have the status. For more information about how to\ninterpret each status check the instance lifecycle documentation.\nCurrently only shown for TPU MIGs.",
+"id": "InstanceGroupManagerStatusInstanceStatusSummary",
+"properties": {
+"deprovisioning": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have DEPROVISIONING status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"nonExistent": {
+"description": "Output only. [Output Only] The number of instances that have not been created yet or\nhave been deleted. Includes only instances that would be shown in the\nlistManagedInstances method and not all instances that have been\ndeleted in the lifetime of the MIG.\nDoes not include FlexStart instances that are waiting for the resources\navailability, they are considered as 'pending'.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"pending": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have PENDING status, that is FlexStart instances that are waiting\nfor resources. Instances that do not exist because of the other reasons\nare counted as 'non_existent'.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"pendingStop": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have PENDING_STOP status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"provisioning": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have PROVISIONING status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"repairing": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have REPAIRING status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"running": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have RUNNING status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"staging": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have STAGING status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"stopped": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have STOPPED status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"stopping": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have STOPPING status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"suspended": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have SUSPENDED status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"suspending": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have SUSPENDING status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"terminated": {
+"description": "Output only. [Output Only] The number of instances in the managed instance group\nthat have TERMINATED status.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+}
+},
+"type": "object"
+},
"InstanceGroupManagerStatusStateful": {
"id": "InstanceGroupManagerStatusStateful",
"properties": {
@@ -71945,6 +72172,9 @@
"tags": {
"$ref": "Tags",
"description": "A list of tags to apply to the instances that are created from these\nproperties. The tags identify valid sources or targets for network\nfirewalls. The setTags method can modify this list of tags. Each tag within\nthe list must comply with RFC1035."
+},
+"workloadIdentityConfig": {
+"$ref": "WorkloadIdentityConfig"
}
},
"type": "object"
@@ -73120,6 +73350,10 @@
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
+"params": {
+"$ref": "InstantSnapshotParams",
+"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
+},
"region": {
"description": "Output only. [Output Only] URL of the region where the instant snapshot resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
@@ -73640,6 +73874,20 @@
},
"type": "object"
},
+"InstantSnapshotParams": {
+"description": "Additional instant snapshot params.",
+"id": "InstantSnapshotParams",
+"properties": {
+"resourceManagerTags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
+"type": "object"
+}
+},
+"type": "object"
+},
"InstantSnapshotResourceStatus": {
"id": "InstantSnapshotResourceStatus",
"properties": {
@@ -74049,7 +74297,7 @@
"type": "string"
},
"subzone": {
-"description": "Specific subzone in the InterconnectLocation that represents where\nthis connection is to be provisioned.",
+"description": "To be deprecated.",
"enum": [
"SUBZONE_A",
"SUBZONE_B"
@@ -81372,7 +81620,7 @@
"type": "object"
},
"NetworkEndpointGroup": {
-"description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be\nreached, whether they are reachable, and where they are located.\nFor more information about using NEGs for different use cases, seeNetwork endpoint groups overview.",
+"description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be\nreached, whether they are reachable, and where they are located.\nFor more information about using NEGs for different use cases, seeNetwork endpoint groups overview.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"id": "NetworkEndpointGroup",
"properties": {
"annotations": {
@@ -82519,6 +82767,10 @@
},
"type": "array"
},
+"enableVpcScopedDns": {
+"description": "Optional. If true, DNS resolution will be enabled over this interface. Only valid\nwith network_attachment.",
+"type": "boolean"
+},
"fingerprint": {
"description": "Fingerprint hash of contents stored in this network interface.\nThis field will be ignored when inserting an Instance or\nadding a NetworkInterface. An up-to-date\nfingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.",
"format": "byte",
@@ -93047,6 +93299,20 @@
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
+"earlyAccessMaintenance": {
+"description": "Indicates the early access maintenance for the reservation.\nIf this field is absent or set to NO_EARLY_ACCESS, the reservation is not\nenrolled in early access maintenance and the standard notice applies.",
+"enum": [
+"NO_EARLY_ACCESS",
+"WAVE1",
+"WAVE2"
+],
+"enumDescriptions": [
+"No early access.",
+"Wave 1: Fastest notification period",
+"Wave 2: Medium notification period"
+],
+"type": "string"
+},
"enableEmergentMaintenance": {
"description": "Indicates whether Compute Engine allows unplanned maintenance for your VMs;\nfor example, to fix hardware errors.",
"type": "boolean"
@@ -95831,6 +96097,10 @@
"description": "Effective enable-oslogin value at Instance level.",
"type": "boolean"
},
+"gceContainerDeclarationMetadataValue": {
+"description": "Effective gce-container-declaration value at Instance level.",
+"type": "boolean"
+},
"serialPortEnableMetadataValue": {
"description": "Effective serial-port-enable value at Instance level.",
"type": "boolean"
@@ -99548,6 +99818,10 @@
"description": "Defines whether the instance is preemptible. This can only be set during\ninstance creation or while the instance isstopped and\ntherefore, in a `TERMINATED` state. SeeInstance Life\nCycle for more information on the possible instance states.",
"type": "boolean"
},
+"preemptionNoticeDuration": {
+"$ref": "Duration",
+"description": "Specifies the Metadata Service preemption notice duration before the GCE ACPI G2 Soft\n Off signal is triggered for Spot\n VMs only. If not specified, there will be no wait before the G2 Soft\n Off signal is triggered."
+},
"provisioningModel": {
"description": "Specifies the provisioning model of the instance.",
"enum": [
@@ -115186,6 +115460,18 @@
},
"type": "object"
},
+"WorkloadIdentityConfig": {
+"id": "WorkloadIdentityConfig",
+"properties": {
+"identity": {
+"type": "string"
+},
+"identityCertificateEnabled": {
+"type": "boolean"
+}
+},
+"type": "object"
+},
"XpnHostList": {
"id": "XpnHostList",
"properties": {
diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json
index 620caa0..b9a8cc3 100644
--- a/googleapiclient/discovery_cache/documents/compute.v1.json
+++ b/googleapiclient/discovery_cache/documents/compute.v1.json
@@ -4327,6 +4327,11 @@
"httpMethod": "GET",
"id": "compute.firewallPolicies.listAssociations",
"parameters": {
+"includeInheritedPolicies": {
+"description": "If set to \"true\", the response will contain a list of all associations for\nthe containing folders and the containing organization of the target. The\nparameter has no effect if the target is an organization.",
+"location": "query",
+"type": "boolean"
+},
"targetResource": {
"description": "The target resource to list associations. It is an organization, or a\nfolder.",
"location": "query",
@@ -6378,7 +6383,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/global/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.insert",
@@ -17594,7 +17599,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.insert",
@@ -28072,7 +28077,7 @@
]
},
"insert": {
-"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.",
+"description": "Creates a network endpoint group in the specified project using the\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.regionNetworkEndpointGroups.insert",
@@ -43137,7 +43142,7 @@
}
}
},
-"revision": "20260122",
+"revision": "20260206",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
@@ -44730,7 +44735,7 @@
"type": "object"
},
"AllocationSpecificSKUAllocationReservedInstanceProperties": {
-"description": "Properties of the SKU instances being reserved.\nNext ID: 9",
+"description": "Properties of the SKU instances being reserved.\nNext ID: 10",
"id": "AllocationSpecificSKUAllocationReservedInstanceProperties",
"properties": {
"guestAccelerators": {
@@ -57936,6 +57941,9 @@
"$ref": "Tags",
"description": "Tags to apply to this instance. Tags are used to identify valid\nsources or targets for network firewalls and are specified by the client\nduring instance creation. The tags can be later modified by the setTags\nmethod. Each tag within the list must comply withRFC1035.\nMultiple tags can be specified via the 'tags.items' field."
},
+"workloadIdentityConfig": {
+"$ref": "WorkloadIdentityConfig"
+},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the instance resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
@@ -59123,6 +59131,20 @@
""
],
"type": "string"
+},
+"onFailedHealthCheck": {
+"description": "The action that a MIG performs on an unhealthy VM. A VM is marked as\nunhealthy when the application running on that VM fails a health check.\nValid values are:\n \n - DEFAULT_ACTION (default): MIG uses the same action\n configured for instanceLifecyclePolicy.defaultActionOnFailure field.\n - REPAIR: MIG automatically repairs an unhealthy VM by\n recreating it.\n - DO_NOTHING: MIG doesn't repair an unhealthy VM.\n For more information, see \n About repairing VMs in a MIG.",
+"enum": [
+"DEFAULT_ACTION",
+"DO_NOTHING",
+"REPAIR"
+],
+"enumDescriptions": [
+"(Default) MIG uses the same action configured for\ninstanceLifecyclePolicy.defaultActionOnFailure field.",
+"MIG doesn't repair an unhealthy VM.",
+"MIG automatically repairs an unhealthy VM by recreating it."
+],
+"type": "string"
}
},
"type": "object"
@@ -61352,6 +61374,9 @@
"tags": {
"$ref": "Tags",
"description": "A list of tags to apply to the instances that are created from these\nproperties. The tags identify valid sources or targets for network\nfirewalls. The setTags method can modify this list of tags. Each tag within\nthe list must comply with RFC1035."
+},
+"workloadIdentityConfig": {
+"$ref": "WorkloadIdentityConfig"
}
},
"type": "object"
@@ -62481,6 +62506,10 @@
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
+"params": {
+"$ref": "InstantSnapshotParams",
+"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
+},
"region": {
"description": "Output only. [Output Only] URL of the region where the instant snapshot resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
@@ -62869,6 +62898,20 @@
},
"type": "object"
},
+"InstantSnapshotParams": {
+"description": "Additional instant snapshot params.",
+"id": "InstantSnapshotParams",
+"properties": {
+"resourceManagerTags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
+"type": "object"
+}
+},
+"type": "object"
+},
"InstantSnapshotResourceStatus": {
"id": "InstantSnapshotResourceStatus",
"properties": {
@@ -63278,7 +63321,7 @@
"type": "string"
},
"subzone": {
-"description": "Specific subzone in the InterconnectLocation that represents where\nthis connection is to be provisioned.",
+"description": "To be deprecated.",
"enum": [
"SUBZONE_A",
"SUBZONE_B"
@@ -69808,7 +69851,7 @@
"type": "object"
},
"NetworkEndpointGroup": {
-"description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be\nreached, whether they are reachable, and where they are located.\nFor more information about using NEGs for different use cases, seeNetwork endpoint groups overview.",
+"description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be\nreached, whether they are reachable, and where they are located.\nFor more information about using NEGs for different use cases, seeNetwork endpoint groups overview.\n\nNote: Use the following APIs to manage network endpoint groups:\n \n - \n To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n NEGs): zonal\n API\n - \n To manage NEGs with regional scope (such as regional internet NEGs,\n serverless NEGs, Private Service Connect NEGs): regional\n API\n - \n To manage NEGs with global scope (such as global internet NEGs):global\n API",
"id": "NetworkEndpointGroup",
"properties": {
"annotations": {
@@ -70878,6 +70921,10 @@
},
"type": "array"
},
+"enableVpcScopedDns": {
+"description": "Optional. If true, DNS resolution will be enabled over this interface. Only valid\nwith network_attachment.",
+"type": "boolean"
+},
"fingerprint": {
"description": "Fingerprint hash of contents stored in this network interface.\nThis field will be ignored when inserting an Instance or\nadding a NetworkInterface. An up-to-date\nfingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.",
"format": "byte",
@@ -80362,6 +80409,20 @@
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
+"earlyAccessMaintenance": {
+"description": "Indicates the early access maintenance for the reservation.\nIf this field is absent or set to NO_EARLY_ACCESS, the reservation is not\nenrolled in early access maintenance and the standard notice applies.",
+"enum": [
+"NO_EARLY_ACCESS",
+"WAVE1",
+"WAVE2"
+],
+"enumDescriptions": [
+"No early access.",
+"Wave 1: Fastest notification period",
+"Wave 2: Medium notification period"
+],
+"type": "string"
+},
"enableEmergentMaintenance": {
"description": "Indicates whether Compute Engine allows unplanned maintenance for your VMs;\nfor example, to fix hardware errors.",
"type": "boolean"
@@ -100003,6 +100064,18 @@
},
"type": "object"
},
+"WorkloadIdentityConfig": {
+"id": "WorkloadIdentityConfig",
+"properties": {
+"identity": {
+"type": "string"
+},
+"identityCertificateEnabled": {
+"type": "boolean"
+}
+},
+"type": "object"
+},
"XpnHostList": {
"id": "XpnHostList",
"properties": {
diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json
index f8fa00a..3f2d13e 100644
--- a/googleapiclient/discovery_cache/documents/connectors.v2.json
+++ b/googleapiclient/discovery_cache/documents/connectors.v2.json
@@ -219,6 +219,59 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"generateConnectionToolspecOverride": {
+"description": "Generate toolspec override for the given list of toolNames.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:generateConnectionToolspecOverride",
+"httpMethod": "POST",
+"id": "connectors.projects.locations.connections.generateConnectionToolspecOverride",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+name}:generateConnectionToolspecOverride",
+"request": {
+"$ref": "GenerateCustomToolspecRequest"
+},
+"response": {
+"$ref": "GenerateCustomToolspecResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"listCustomToolNames": {
+"description": "Lists custom tool names.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:listCustomToolNames",
+"httpMethod": "GET",
+"id": "connectors.projects.locations.connections.listCustomToolNames",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+name}:listCustomToolNames",
+"response": {
+"$ref": "ListCustomToolNamesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"refreshAccessToken": {
"description": "RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:refreshAccessToken",
@@ -965,7 +1018,7 @@
}
}
},
-"revision": "20251216",
+"revision": "20260128",
"rootUrl": "https://connectors.googleapis.com/",
"schemas": {
"AccessCredentials": {
@@ -1633,6 +1686,29 @@
},
"type": "object"
},
+"GenerateCustomToolspecRequest": {
+"id": "GenerateCustomToolspecRequest",
+"properties": {
+"toolNames": {
+"description": "list of tools to be generated.",
+"items": {
+"$ref": "ToolName"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GenerateCustomToolspecResponse": {
+"id": "GenerateCustomToolspecResponse",
+"properties": {
+"toolSpec": {
+"$ref": "ToolSpec",
+"description": "tool spec that has tool_defitions array containing the tools for all sted tool_names."
+}
+},
+"type": "object"
+},
"GetResourcePostRequest": {
"description": "Request message for ConnectorAgentService.GetResourcePost",
"id": "GetResourcePostRequest",
@@ -2221,6 +2297,19 @@
},
"type": "object"
},
+"ListCustomToolNamesResponse": {
+"id": "ListCustomToolNamesResponse",
+"properties": {
+"toolNames": {
+"description": "List of custom tools.",
+"items": {
+"$ref": "ToolName"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"ListEntitiesResponse": {
"description": "Response message for EntityService.ListEntities",
"id": "ListEntitiesResponse",
@@ -3165,6 +3254,40 @@
},
"type": "object"
},
+"ToolName": {
+"id": "ToolName",
+"properties": {
+"entityName": {
+"description": "Entity name for which the tool was generated.",
+"type": "string"
+},
+"name": {
+"description": "Tool name that was generated in the list tools call.",
+"type": "string"
+},
+"operation": {
+"description": "Operation for which the tool was generated.",
+"enum": [
+"OPERATION_UNSPECIFIED",
+"LIST",
+"GET",
+"CREATE",
+"UPDATE",
+"DELETE"
+],
+"enumDescriptions": [
+"Operation unspecified.",
+"LIST entities.",
+"GET entity.",
+"CREATE entity.",
+"UPDATE entity.",
+"DELETE entity."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
"ToolSpec": {
"id": "ToolSpec",
"properties": {
diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json
index 839103c..34d0d94 100644
--- a/googleapiclient/discovery_cache/documents/container.v1.json
+++ b/googleapiclient/discovery_cache/documents/container.v1.json
@@ -2660,7 +2660,7 @@
}
}
},
-"revision": "20260120",
+"revision": "20260209",
"rootUrl": "https://container.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -3501,7 +3501,8 @@
},
"compliancePostureConfig": {
"$ref": "CompliancePostureConfig",
-"description": "Enable/Disable Compliance Posture features for the cluster."
+"deprecated": true,
+"description": "Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster."
},
"conditions": {
"description": "Which conditions caused the current cluster state.",
@@ -3779,7 +3780,7 @@
},
"securityPostureConfig": {
"$ref": "SecurityPostureConfig",
-"description": "Enable/Disable Security Posture API features for the cluster."
+"description": "Optional. Enable/Disable Security Posture API features for the cluster."
},
"selfLink": {
"description": "Output only. Server-defined URL for the resource.",
@@ -3863,11 +3864,13 @@
"description": "Autopilot general profile for the cluster, which defines the configuration for the cluster.",
"enum": [
"AUTOPILOT_GENERAL_PROFILE_UNSPECIFIED",
-"NO_PERFORMANCE"
+"NO_PERFORMANCE",
+"NONE"
],
"enumDescriptions": [
"Use default configuration.",
-"Avoid extra IP consumption."
+"Avoid extra IP consumption.",
+"Use default configuration."
],
"type": "string"
},
@@ -3975,7 +3978,8 @@
},
"desiredCompliancePostureConfig": {
"$ref": "CompliancePostureConfig",
-"description": "Enable/Disable Compliance Posture features for the cluster."
+"deprecated": true,
+"description": "Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster."
},
"desiredContainerdConfig": {
"$ref": "ContainerdConfig",
@@ -4397,7 +4401,8 @@
"type": "object"
},
"CompliancePostureConfig": {
-"description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.",
+"deprecated": true,
+"description": "Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.",
"id": "CompliancePostureConfig",
"properties": {
"complianceStandards": {
@@ -4532,6 +4537,17 @@
},
"type": "object"
},
+"CrashLoopBackOffConfig": {
+"description": "Contains config to modify node-level parameters for container restart behavior.",
+"id": "CrashLoopBackOffConfig",
+"properties": {
+"maxContainerRestartPeriod": {
+"description": "Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"\u00b5s\"), \"ms\", \"s\", \"m\", \"h\". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.",
+"type": "string"
+}
+},
+"type": "object"
+},
"CreateClusterRequest": {
"description": "CreateClusterRequest creates a cluster.",
"id": "CreateClusterRequest",
@@ -4806,6 +4822,35 @@
},
"type": "object"
},
+"DisruptionBudget": {
+"description": "DisruptionBudget defines the upgrade disruption budget for the cluster control plane.",
+"id": "DisruptionBudget",
+"properties": {
+"lastDisruptionTime": {
+"description": "Output only. The last time a disruption was performed on the control plane.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"lastMinorVersionDisruptionTime": {
+"description": "Output only. The last time a minor version upgrade was performed on the control plane.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"minorVersionDisruptionInterval": {
+"description": "Optional. The minimum duration between two minor version upgrades of the control plane.",
+"format": "google-duration",
+"type": "string"
+},
+"patchVersionDisruptionInterval": {
+"description": "Optional. The minimum duration between two patch version upgrades of the control plane.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
"DisruptionEvent": {
"description": "DisruptionEvent is a notification sent to customers about the disruption event of a resource.",
"id": "DisruptionEvent",
@@ -6055,6 +6100,10 @@
"description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
"id": "MaintenancePolicy",
"properties": {
+"disruptionBudget": {
+"$ref": "DisruptionBudget",
+"description": "Optional. The upgrade disruption budget for the cluster control plane."
+},
"resourceVersion": {
"description": "A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.",
"type": "string"
@@ -6877,6 +6926,10 @@
"description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.",
"type": "string"
},
+"crashLoopBackOff": {
+"$ref": "CrashLoopBackOffConfig",
+"description": "Optional. Contains configuration options to modify node-level parameters for container restart behavior."
+},
"evictionMaxPodGracePeriodSeconds": {
"description": "Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].",
"format": "int32",
@@ -6930,6 +6983,16 @@
"format": "int64",
"type": "string"
},
+"shutdownGracePeriodCriticalPodsSeconds": {
+"description": "Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].",
+"format": "int32",
+"type": "integer"
+},
+"shutdownGracePeriodSeconds": {
+"description": "Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.",
+"format": "int32",
+"type": "integer"
+},
"singleProcessOomKill": {
"description": "Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.",
"type": "boolean"
@@ -7028,7 +7091,7 @@
"type": "string"
},
"subnetwork": {
-"description": "Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.",
+"description": "Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.",
"type": "string"
}
},
@@ -8324,11 +8387,17 @@
"BASIC",
"ENTERPRISE"
],
+"enumDeprecated": [
+false,
+false,
+false,
+true
+],
"enumDescriptions": [
"Default value not specified.",
"Disables Security Posture features on the cluster.",
"Applies Security Posture features on the cluster.",
-"Applies the Security Posture off cluster Enterprise level features."
+"Deprecated: Security Posture Enterprise features are no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Applies the Security Posture off cluster Enterprise level features."
],
"type": "string"
},
@@ -8340,10 +8409,16 @@
"VULNERABILITY_BASIC",
"VULNERABILITY_ENTERPRISE"
],
+"enumDeprecated": [
+false,
+false,
+true,
+false
+],
"enumDescriptions": [
"Default value not specified.",
"Disables vulnerability scanning on the cluster.",
-"Applies basic vulnerability scanning on the cluster.",
+"Deprecated: Basic vulnerability scanning is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Applies basic vulnerability scanning on the cluster.",
"Applies the Security Posture's vulnerability on cluster Enterprise level features."
],
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json
index 614d8b0..231fb3b 100644
--- a/googleapiclient/discovery_cache/documents/container.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json
@@ -2741,7 +2741,7 @@
}
}
},
-"revision": "20260120",
+"revision": "20260209",
"rootUrl": "https://container.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -3660,7 +3660,8 @@
},
"compliancePostureConfig": {
"$ref": "CompliancePostureConfig",
-"description": "Enable/Disable Compliance Posture features for the cluster."
+"deprecated": true,
+"description": "Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster."
},
"conditions": {
"description": "Which conditions caused the current cluster state.",
@@ -3974,7 +3975,7 @@
},
"securityPostureConfig": {
"$ref": "SecurityPostureConfig",
-"description": "Enable/Disable Security Posture API features for the cluster."
+"description": "Optional. Enable/Disable Security Posture API features for the cluster."
},
"selfLink": {
"description": "Output only. Server-defined URL for the resource.",
@@ -4071,11 +4072,13 @@
"description": "Autopilot general profile for the cluster, which defines the configuration for the cluster.",
"enum": [
"AUTOPILOT_GENERAL_PROFILE_UNSPECIFIED",
-"NO_PERFORMANCE"
+"NO_PERFORMANCE",
+"NONE"
],
"enumDescriptions": [
"Use default configuration.",
-"Avoid extra IP consumption."
+"Avoid extra IP consumption.",
+"Use default configuration."
],
"type": "string"
},
@@ -4210,7 +4213,8 @@
},
"desiredCompliancePostureConfig": {
"$ref": "CompliancePostureConfig",
-"description": "Enable/Disable Compliance Posture features for the cluster."
+"deprecated": true,
+"description": "Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster."
},
"desiredContainerdConfig": {
"$ref": "ContainerdConfig",
@@ -4708,7 +4712,8 @@
"type": "object"
},
"CompliancePostureConfig": {
-"description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.",
+"deprecated": true,
+"description": "Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.",
"id": "CompliancePostureConfig",
"properties": {
"complianceStandards": {
@@ -4843,6 +4848,17 @@
},
"type": "object"
},
+"CrashLoopBackOffConfig": {
+"description": "Contains config to modify node-level parameters for container restart behavior.",
+"id": "CrashLoopBackOffConfig",
+"properties": {
+"maxContainerRestartPeriod": {
+"description": "Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"\u00b5s\"), \"ms\", \"s\", \"m\", \"h\". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details.",
+"type": "string"
+}
+},
+"type": "object"
+},
"CreateClusterRequest": {
"description": "CreateClusterRequest creates a cluster.",
"id": "CreateClusterRequest",
@@ -5139,6 +5155,35 @@
},
"type": "object"
},
+"DisruptionBudget": {
+"description": "DisruptionBudget defines the upgrade disruption budget for the cluster control plane.",
+"id": "DisruptionBudget",
+"properties": {
+"lastDisruptionTime": {
+"description": "Output only. The last time a disruption was performed on the control plane.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"lastMinorVersionDisruptionTime": {
+"description": "Output only. The last time a minor version upgrade was performed on the control plane.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"minorVersionDisruptionInterval": {
+"description": "Optional. The minimum duration between two minor version upgrades of the control plane.",
+"format": "google-duration",
+"type": "string"
+},
+"patchVersionDisruptionInterval": {
+"description": "Optional. The minimum duration between two patch version upgrades of the control plane.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
"DisruptionEvent": {
"description": "DisruptionEvent is a notification sent to customers about the disruption event of a resource.",
"id": "DisruptionEvent",
@@ -6513,6 +6558,10 @@
"description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
"id": "MaintenancePolicy",
"properties": {
+"disruptionBudget": {
+"$ref": "DisruptionBudget",
+"description": "Optional. The upgrade disruption budget for the cluster control plane."
+},
"resourceVersion": {
"description": "A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.",
"type": "string"
@@ -7391,6 +7440,10 @@
"description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.",
"type": "string"
},
+"crashLoopBackOff": {
+"$ref": "CrashLoopBackOffConfig",
+"description": "Optional. Contains configuration options to modify node-level parameters for container restart behavior."
+},
"evictionMaxPodGracePeriodSeconds": {
"description": "Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].",
"format": "int32",
@@ -7444,6 +7497,16 @@
"format": "int64",
"type": "string"
},
+"shutdownGracePeriodCriticalPodsSeconds": {
+"description": "Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120].",
+"format": "int32",
+"type": "integer"
+},
+"shutdownGracePeriodSeconds": {
+"description": "Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120.",
+"format": "int32",
+"type": "integer"
+},
"singleProcessOomKill": {
"description": "Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.",
"type": "boolean"
@@ -7546,7 +7609,7 @@
"type": "string"
},
"subnetwork": {
-"description": "Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: 1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet 2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.",
+"description": "Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.",
"type": "string"
}
},
@@ -8990,11 +9053,17 @@
"BASIC",
"ENTERPRISE"
],
+"enumDeprecated": [
+false,
+false,
+false,
+true
+],
"enumDescriptions": [
"Default value not specified.",
"Disables Security Posture features on the cluster.",
"Applies Security Posture features on the cluster.",
-"Applies the Security Posture off cluster Enterprise level features."
+"Deprecated: Security Posture Enterprise features are no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Applies the Security Posture off cluster Enterprise level features."
],
"type": "string"
},
@@ -9006,10 +9075,16 @@
"VULNERABILITY_BASIC",
"VULNERABILITY_ENTERPRISE"
],
+"enumDeprecated": [
+false,
+false,
+true,
+false
+],
"enumDescriptions": [
"Default value not specified.",
"Disables vulnerability scanning on the cluster.",
-"Applies basic vulnerability scanning on the cluster.",
+"Deprecated: Basic vulnerability scanning is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Applies basic vulnerability scanning on the cluster.",
"Applies the Security Posture's vulnerability on cluster Enterprise level features."
],
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1.json
index 18a455f..59cd61c 100644
--- a/googleapiclient/discovery_cache/documents/datacatalog.v1.json
+++ b/googleapiclient/discovery_cache/documents/datacatalog.v1.json
@@ -2344,7 +2344,7 @@
}
}
},
-"revision": "20251226",
+"revision": "20260211",
"rootUrl": "https://datacatalog.googleapis.com/",
"schemas": {
"Binding": {
@@ -4758,7 +4758,7 @@
"type": "object"
},
"GoogleCloudDatacatalogV1TagTemplate": {
-"description": "A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.",
+"description": "A tag template defines a tag that can have one or more typed fields. The template is used to create tags that are attached to Google Cloud resources. [Tag template roles] (https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. For example, see the [TagTemplate User] (https://cloud.google.com/data-catalog/docs/how-to/template-user) role that includes a permission to use the tag template to tag resources.",
"id": "GoogleCloudDatacatalogV1TagTemplate",
"properties": {
"dataplexTransferStatus": {
diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json
index 0d29084..9676e4b 100644
--- a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json
@@ -1855,7 +1855,7 @@
}
}
},
-"revision": "20251226",
+"revision": "20260211",
"rootUrl": "https://datacatalog.googleapis.com/",
"schemas": {
"Binding": {
@@ -4577,7 +4577,7 @@
"type": "object"
},
"GoogleCloudDatacatalogV1beta1TagTemplate": {
-"description": "A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.",
+"description": "A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/roles-permissions/datacatalog) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.",
"id": "GoogleCloudDatacatalogV1beta1TagTemplate",
"properties": {
"dataplexTransferStatus": {
diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json
index 22ac353..ebcd40e 100644
--- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json
+++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json
@@ -91,6 +91,11 @@
},
{
"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.europe-north1.rep.googleapis.com/",
+"location": "europe-north1"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://dataflow.europe-southwest1.rep.googleapis.com/",
"location": "europe-southwest1"
},
@@ -111,11 +116,21 @@
},
{
"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.europe-west2.rep.googleapis.com/",
+"location": "europe-west2"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/",
"location": "europe-west3"
},
{
"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.europe-west4.rep.googleapis.com/",
+"location": "europe-west4"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://dataflow.europe-west6.rep.googleapis.com/",
"location": "europe-west6"
},
@@ -161,6 +176,11 @@
},
{
"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.southamerica-east1.rep.googleapis.com/",
+"location": "southamerica-east1"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://dataflow.southamerica-west1.rep.googleapis.com/",
"location": "southamerica-west1"
},
@@ -2375,7 +2395,7 @@
}
}
},
-"revision": "20260127",
+"revision": "20260208",
"rootUrl": "https://dataflow.googleapis.com/",
"schemas": {
"ApproximateProgress": {
@@ -4259,6 +4279,11 @@
"description": "Optional. The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`",
"type": "string"
},
+"pausable": {
+"description": "Output only. Indicates whether the job can be paused.",
+"readOnly": true,
+"type": "boolean"
+},
"pipelineDescription": {
"$ref": "PipelineDescription",
"description": "Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
@@ -5951,10 +5976,15 @@
"id": "RuntimeUpdatableParams",
"properties": {
"acceptableBacklogDuration": {
-"description": "Optional. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.",
+"deprecated": true,
+"description": "Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.",
"format": "google-duration",
"type": "string"
},
+"autoscalingTier": {
+"description": "Optional. The backlog threshold tier for autoscaling. Value must be one of \"low-latency\", \"medium-latency\", or \"high-latency\".",
+"type": "string"
+},
"maxNumWorkers": {
"description": "The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.",
"format": "int32",
diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index 6aa15d3..e9c5293 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -824,7 +824,7 @@
]
},
"lookupEntry": {
-"description": "Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).",
+"description": "Looks up an entry by name using the permission on the source system.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry",
"httpMethod": "GET",
"id": "dataplex.projects.locations.lookupEntry",
@@ -3372,7 +3372,7 @@
]
},
"get": {
-"description": "Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).",
+"description": "Gets an Entry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.entries.get",
@@ -3428,7 +3428,7 @@
]
},
"list": {
-"description": "Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).",
+"description": "Lists Entries within an EntryGroup.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries",
"httpMethod": "GET",
"id": "dataplex.projects.locations.entryGroups.entries.list",
@@ -7772,13 +7772,104 @@
]
}
}
+},
+"policyIntents": {
+"methods": {
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/policyIntents/{policyIntentsId}:getIamPolicy",
+"httpMethod": "GET",
+"id": "dataplex.projects.locations.policyIntents.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/policyIntents/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/policyIntents/{policyIntentsId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "dataplex.projects.locations.policyIntents.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/policyIntents/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/policyIntents/{policyIntentsId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "dataplex.projects.locations.policyIntents.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/policyIntents/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:testIamPermissions",
+"request": {
+"$ref": "GoogleIamV1TestIamPermissionsRequest"
+},
+"response": {
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
}
}
}
}
}
},
-"revision": "20260127",
+"revision": "20260203",
"rootUrl": "https://dataplex.googleapis.com/",
"schemas": {
"Empty": {
@@ -10028,7 +10119,7 @@
"type": "string"
},
"dimension": {
-"description": "Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.",
+"description": "Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.",
"type": "string"
},
"ignoreNull": {
diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json
index 204631a..4510418 100644
--- a/googleapiclient/discovery_cache/documents/dataproc.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json
@@ -478,7 +478,7 @@
"type": "string"
},
"requestId": {
-"description": "Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
+"description": "Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the operation that corresponds to the first Batch created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"location": "query",
"type": "string"
}
@@ -5032,7 +5032,7 @@
}
}
},
-"revision": "20260122",
+"revision": "20260204",
"rootUrl": "https://dataproc.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json
index c5dd774..03cbf9d 100644
--- a/googleapiclient/discovery_cache/documents/datastream.v1.json
+++ b/googleapiclient/discovery_cache/documents/datastream.v1.json
@@ -1266,7 +1266,7 @@
}
}
},
-"revision": "20260128",
+"revision": "20260204",
"rootUrl": "https://datastream.googleapis.com/",
"schemas": {
"AppendOnly": {
@@ -1388,6 +1388,20 @@
"properties": {},
"type": "object"
},
+"BadRequest": {
+"description": "Describes violations in a client request. This error type focuses on the syntactic aspects of the request.",
+"id": "BadRequest",
+"properties": {
+"fieldViolations": {
+"description": "Describes all violations in a client request.",
+"items": {
+"$ref": "FieldViolation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"BasicEncryption": {
"description": "Message to represent the option where Datastream will enforce encryption without authenticating server identity. Server certificates will be trusted by default.",
"id": "BasicEncryption",
@@ -1685,6 +1699,24 @@
},
"type": "object"
},
+"DebugInfo": {
+"description": "Describes additional debugging info.",
+"id": "DebugInfo",
+"properties": {
+"detail": {
+"description": "Additional debugging information provided by the server.",
+"type": "string"
+},
+"stackEntries": {
+"description": "The stack trace entries indicating where the error occurred.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"DestinationConfig": {
"description": "The configuration of the stream destination.",
"id": "DestinationConfig",
@@ -1855,6 +1887,28 @@
},
"type": "object"
},
+"ErrorInfo": {
+"description": "Describes the cause of the error with structured details. Example of an error when contacting the \"pubsub.googleapis.com\" API when it is not enabled: { \"reason\": \"API_DISABLED\" \"domain\": \"googleapis.com\" \"metadata\": { \"resource\": \"projects/123\", \"service\": \"pubsub.googleapis.com\" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { \"reason\": \"STOCKOUT\" \"domain\": \"spanner.googleapis.com\", \"metadata\": { \"availableRegions\": \"us-central1,us-east2\" } }",
+"id": "ErrorInfo",
+"properties": {
+"domain": {
+"description": "The logical grouping to which the \"reason\" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: \"pubsub.googleapis.com\". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is \"googleapis.com\".",
+"type": "string"
+},
+"metadata": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{\"instanceLimit\": \"100/request\"}`, should be returned as, `{\"instanceLimitPerRequest\": \"100\"}`, if the client exceeds the number of instances that can be created in a single (batch) request.",
+"type": "object"
+},
+"reason": {
+"description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.",
+"type": "string"
+}
+},
+"type": "object"
+},
"EventFilter": {
"description": "Represents a filter for included data on a stream object.",
"id": "EventFilter",
@@ -1884,6 +1938,29 @@
},
"type": "object"
},
+"FieldViolation": {
+"description": "A message type used to describe a single bad request field.",
+"id": "FieldViolation",
+"properties": {
+"description": {
+"description": "A description of why the request element is bad.",
+"type": "string"
+},
+"field": {
+"description": "A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[1].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[3].type[2]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message.",
+"type": "string"
+},
+"localizedMessage": {
+"$ref": "LocalizedMessage",
+"description": "Provides a localized error message for field-level errors that is safe to return to the API consumer."
+},
+"reason": {
+"description": "The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.",
+"type": "string"
+}
+},
+"type": "object"
+},
"ForwardSshTunnelConnectivity": {
"description": "Forward SSH Tunnel connectivity.",
"id": "ForwardSshTunnelConnectivity",
@@ -1962,6 +2039,20 @@
"properties": {},
"type": "object"
},
+"Help": {
+"description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.",
+"id": "Help",
+"properties": {
+"links": {
+"description": "URL(s) pointing to additional information on handling the current error.",
+"items": {
+"$ref": "Link"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"HostAddress": {
"description": "A HostAddress represents a transport end point, which is the combination of an IP address or hostname and a port number.",
"id": "HostAddress",
@@ -2064,6 +2155,21 @@
},
"type": "object"
},
+"Link": {
+"description": "Describes a URL link.",
+"id": "Link",
+"properties": {
+"description": {
+"description": "Describes what the link offers.",
+"type": "string"
+},
+"url": {
+"description": "The URL of the link.",
+"type": "string"
+}
+},
+"type": "object"
+},
"ListConnectionProfilesResponse": {
"description": "Response message for listing connection profiles.",
"id": "ListConnectionProfilesResponse",
@@ -2225,6 +2331,21 @@
},
"type": "object"
},
+"LocalizedMessage": {
+"description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.",
+"id": "LocalizedMessage",
+"properties": {
+"locale": {
+"description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"",
+"type": "string"
+},
+"message": {
+"description": "The localized error message in the above locale.",
+"type": "string"
+}
+},
+"type": "object"
+},
"Location": {
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
@@ -3338,6 +3459,39 @@
},
"type": "object"
},
+"PreconditionFailure": {
+"description": "Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.",
+"id": "PreconditionFailure",
+"properties": {
+"violations": {
+"description": "Describes all precondition violations.",
+"items": {
+"$ref": "PreconditionFailureViolation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"PreconditionFailureViolation": {
+"description": "A message type used to describe a single precondition failure.",
+"id": "PreconditionFailureViolation",
+"properties": {
+"description": {
+"description": "A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: \"Terms of service not accepted\".",
+"type": "string"
+},
+"subject": {
+"description": "The subject, relative to the type, that failed. For example, \"google.com/cloud\" relative to the \"TOS\" type would indicate which terms of service is being referenced.",
+"type": "string"
+},
+"type": {
+"description": "The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, \"TOS\" for \"Terms of Service violation\".",
+"type": "string"
+}
+},
+"type": "object"
+},
"PrivateConnection": {
"description": "The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.",
"id": "PrivateConnection",
@@ -3439,6 +3593,114 @@
},
"type": "object"
},
+"QuotaFailure": {
+"description": "Describes how a quota check failed. For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set `service_disabled` to true. Also see RetryInfo and Help types for other details about handling a quota failure.",
+"id": "QuotaFailure",
+"properties": {
+"violations": {
+"description": "Describes all quota violations.",
+"items": {
+"$ref": "QuotaFailureViolation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"QuotaFailureViolation": {
+"description": "A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.",
+"id": "QuotaFailureViolation",
+"properties": {
+"apiService": {
+"description": "The API Service from which the `QuotaFailure.Violation` orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".",
+"type": "string"
+},
+"description": {
+"description": "A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console. For example: \"Service disabled\" or \"Daily Limit for read operations exceeded\".",
+"type": "string"
+},
+"futureQuotaValue": {
+"description": "The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set. For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.",
+"format": "int64",
+"type": "string"
+},
+"quotaDimensions": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased. For example, the quota \"CPUs per region per VM family\" enforces a limit on the metric \"compute.googleapis.com/cpus_per_vm_family\" on dimensions \"region\" and \"vm_family\". And if the violation occurred in region \"us-central1\" and for VM family \"n1\", the quota_dimensions would be, { \"region\": \"us-central1\", \"vm_family\": \"n1\", } When a quota is enforced globally, the quota_dimensions would always be empty.",
+"type": "object"
+},
+"quotaId": {
+"description": "The id of the violated quota. Also know as \"limit name\", this is the unique identifier of a quota in the context of an API service. For example, \"CPUS-PER-VM-FAMILY-per-project-region\".",
+"type": "string"
+},
+"quotaMetric": {
+"description": "The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected. For example, \"compute.googleapis.com/cpus_per_vm_family\", \"storage.googleapis.com/internet_egress_bandwidth\".",
+"type": "string"
+},
+"quotaValue": {
+"description": "The enforced quota value at the time of the `QuotaFailure`. For example, if the enforced quota value at the time of the `QuotaFailure` on the number of CPUs is \"10\", then the value of this field would reflect this quantity.",
+"format": "int64",
+"type": "string"
+},
+"subject": {
+"description": "The subject on which the quota check failed. For example, \"clientip:\" or \"project:\".",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RequestInfo": {
+"description": "Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.",
+"id": "RequestInfo",
+"properties": {
+"requestId": {
+"description": "An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.",
+"type": "string"
+},
+"servingData": {
+"description": "Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ResourceInfo": {
+"description": "Describes the resource that is being accessed.",
+"id": "ResourceInfo",
+"properties": {
+"description": {
+"description": "Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the `writer` permission on the developer console project.",
+"type": "string"
+},
+"owner": {
+"description": "The owner of the resource (optional). For example, \"user:\" or \"project:\".",
+"type": "string"
+},
+"resourceName": {
+"description": "The name of the resource being accessed. For example, a shared calendar name: \"[email protected]\", if the current error is google.rpc.Code.PERMISSION_DENIED.",
+"type": "string"
+},
+"resourceType": {
+"description": "A name for the type of resource being accessed, e.g. \"sql table\", \"cloud storage bucket\", \"file\", \"Google calendar\"; or the type URL of the resource: e.g. \"type.googleapis.com/google.pubsub.v1.Topic\".",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RetryInfo": {
+"description": "Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses. It's always recommended that clients should use exponential backoff when retrying. Clients should wait until `retry_delay` amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on `retry_delay`, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.",
+"id": "RetryInfo",
+"properties": {
+"retryDelay": {
+"description": "Clients should wait at least this long between retrying the same request.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
"Route": {
"description": "The route resource is the child of the private connection resource, used for defining a route for a private connection.",
"id": "Route",
diff --git a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json
index 658bb8c..7932dc0 100644
--- a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json
@@ -1235,7 +1235,7 @@
}
}
},
-"revision": "20260128",
+"revision": "20260204",
"rootUrl": "https://datastream.googleapis.com/",
"schemas": {
"AvroFileFormat": {
@@ -1330,6 +1330,20 @@
"properties": {},
"type": "object"
},
+"BadRequest": {
+"description": "Describes violations in a client request. This error type focuses on the syntactic aspects of the request.",
+"id": "BadRequest",
+"properties": {
+"fieldViolations": {
+"description": "Describes all violations in a client request.",
+"items": {
+"$ref": "FieldViolation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
@@ -1398,6 +1412,24 @@
},
"type": "object"
},
+"DebugInfo": {
+"description": "Describes additional debugging info.",
+"id": "DebugInfo",
+"properties": {
+"detail": {
+"description": "Additional debugging information provided by the server.",
+"type": "string"
+},
+"stackEntries": {
+"description": "The stack trace entries indicating where the error occurred.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"DestinationConfig": {
"description": "The configuration of the stream destination.",
"id": "DestinationConfig",
@@ -1502,6 +1534,28 @@
},
"type": "object"
},
+"ErrorInfo": {
+"description": "Describes the cause of the error with structured details. Example of an error when contacting the \"pubsub.googleapis.com\" API when it is not enabled: { \"reason\": \"API_DISABLED\" \"domain\": \"googleapis.com\" \"metadata\": { \"resource\": \"projects/123\", \"service\": \"pubsub.googleapis.com\" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { \"reason\": \"STOCKOUT\" \"domain\": \"spanner.googleapis.com\", \"metadata\": { \"availableRegions\": \"us-central1,us-east2\" } }",
+"id": "ErrorInfo",
+"properties": {
+"domain": {
+"description": "The logical grouping to which the \"reason\" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: \"pubsub.googleapis.com\". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is \"googleapis.com\".",
+"type": "string"
+},
+"metadata": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{\"instanceLimit\": \"100/request\"}`, should be returned as, `{\"instanceLimitPerRequest\": \"100\"}`, if the client exceeds the number of instances that can be created in a single (batch) request.",
+"type": "object"
+},
+"reason": {
+"description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.",
+"type": "string"
+}
+},
+"type": "object"
+},
"FetchErrorsRequest": {
"description": "Request message for 'FetchErrors' request.",
"id": "FetchErrorsRequest",
@@ -1540,6 +1594,29 @@
},
"type": "object"
},
+"FieldViolation": {
+"description": "A message type used to describe a single bad request field.",
+"id": "FieldViolation",
+"properties": {
+"description": {
+"description": "A description of why the request element is bad.",
+"type": "string"
+},
+"field": {
+"description": "A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[1].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[3].type[2]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message.",
+"type": "string"
+},
+"localizedMessage": {
+"$ref": "LocalizedMessage",
+"description": "Provides a localized error message for field-level errors that is safe to return to the API consumer."
+},
+"reason": {
+"description": "The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.",
+"type": "string"
+}
+},
+"type": "object"
+},
"ForwardSshTunnelConnectivity": {
"description": "Forward SSH Tunnel connectivity.",
"id": "ForwardSshTunnelConnectivity",
@@ -1625,6 +1702,20 @@
},
"type": "object"
},
+"Help": {
+"description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.",
+"id": "Help",
+"properties": {
+"links": {
+"description": "URL(s) pointing to additional information on handling the current error.",
+"items": {
+"$ref": "Link"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"JsonFileFormat": {
"description": "JSON file format configuration.",
"id": "JsonFileFormat",
@@ -1660,6 +1751,21 @@
},
"type": "object"
},
+"Link": {
+"description": "Describes a URL link.",
+"id": "Link",
+"properties": {
+"description": {
+"description": "Describes what the link offers.",
+"type": "string"
+},
+"url": {
+"description": "The URL of the link.",
+"type": "string"
+}
+},
+"type": "object"
+},
"ListConnectionProfilesResponse": {
"id": "ListConnectionProfilesResponse",
"properties": {
@@ -1818,6 +1924,21 @@
},
"type": "object"
},
+"LocalizedMessage": {
+"description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.",
+"id": "LocalizedMessage",
+"properties": {
+"locale": {
+"description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"",
+"type": "string"
+},
+"message": {
+"description": "The localized error message in the above locale.",
+"type": "string"
+}
+},
+"type": "object"
+},
"Location": {
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
@@ -2287,6 +2408,39 @@
},
"type": "object"
},
+"PreconditionFailure": {
+"description": "Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.",
+"id": "PreconditionFailure",
+"properties": {
+"violations": {
+"description": "Describes all precondition violations.",
+"items": {
+"$ref": "PreconditionFailureViolation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"PreconditionFailureViolation": {
+"description": "A message type used to describe a single precondition failure.",
+"id": "PreconditionFailureViolation",
+"properties": {
+"description": {
+"description": "A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: \"Terms of service not accepted\".",
+"type": "string"
+},
+"subject": {
+"description": "The subject, relative to the type, that failed. For example, \"google.com/cloud\" relative to the \"TOS\" type would indicate which terms of service is being referenced.",
+"type": "string"
+},
+"type": {
+"description": "The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, \"TOS\" for \"Terms of Service violation\".",
+"type": "string"
+}
+},
+"type": "object"
+},
"PrivateConnection": {
"description": "The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.",
"id": "PrivateConnection",
@@ -2362,6 +2516,114 @@
},
"type": "object"
},
+"QuotaFailure": {
+"description": "Describes how a quota check failed. For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set `service_disabled` to true. Also see RetryInfo and Help types for other details about handling a quota failure.",
+"id": "QuotaFailure",
+"properties": {
+"violations": {
+"description": "Describes all quota violations.",
+"items": {
+"$ref": "QuotaFailureViolation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"QuotaFailureViolation": {
+"description": "A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.",
+"id": "QuotaFailureViolation",
+"properties": {
+"apiService": {
+"description": "The API Service from which the `QuotaFailure.Violation` orginates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".",
+"type": "string"
+},
+"description": {
+"description": "A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console. For example: \"Service disabled\" or \"Daily Limit for read operations exceeded\".",
+"type": "string"
+},
+"futureQuotaValue": {
+"description": "The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set. For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.",
+"format": "int64",
+"type": "string"
+},
+"quotaDimensions": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased. For example, the quota \"CPUs per region per VM family\" enforces a limit on the metric \"compute.googleapis.com/cpus_per_vm_family\" on dimensions \"region\" and \"vm_family\". And if the violation occurred in region \"us-central1\" and for VM family \"n1\", the quota_dimensions would be, { \"region\": \"us-central1\", \"vm_family\": \"n1\", } When a quota is enforced globally, the quota_dimensions would always be empty.",
+"type": "object"
+},
+"quotaId": {
+"description": "The id of the violated quota. Also know as \"limit name\", this is the unique identifier of a quota in the context of an API service. For example, \"CPUS-PER-VM-FAMILY-per-project-region\".",
+"type": "string"
+},
+"quotaMetric": {
+"description": "The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected. For example, \"compute.googleapis.com/cpus_per_vm_family\", \"storage.googleapis.com/internet_egress_bandwidth\".",
+"type": "string"
+},
+"quotaValue": {
+"description": "The enforced quota value at the time of the `QuotaFailure`. For example, if the enforced quota value at the time of the `QuotaFailure` on the number of CPUs is \"10\", then the value of this field would reflect this quantity.",
+"format": "int64",
+"type": "string"
+},
+"subject": {
+"description": "The subject on which the quota check failed. For example, \"clientip:\" or \"project:\".",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RequestInfo": {
+"description": "Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.",
+"id": "RequestInfo",
+"properties": {
+"requestId": {
+"description": "An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.",
+"type": "string"
+},
+"servingData": {
+"description": "Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ResourceInfo": {
+"description": "Describes the resource that is being accessed.",
+"id": "ResourceInfo",
+"properties": {
+"description": {
+"description": "Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the `writer` permission on the developer console project.",
+"type": "string"
+},
+"owner": {
+"description": "The owner of the resource (optional). For example, \"user:\" or \"project:\".",
+"type": "string"
+},
+"resourceName": {
+"description": "The name of the resource being accessed. For example, a shared calendar name: \"[email protected]\", if the current error is google.rpc.Code.PERMISSION_DENIED.",
+"type": "string"
+},
+"resourceType": {
+"description": "A name for the type of resource being accessed, e.g. \"sql table\", \"cloud storage bucket\", \"file\", \"Google calendar\"; or the type URL of the resource: e.g. \"type.googleapis.com/google.pubsub.v1.Topic\".",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RetryInfo": {
+"description": "Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses. It's always recommended that clients should use exponential backoff when retrying. Clients should wait until `retry_delay` amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on `retry_delay`, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.",
+"id": "RetryInfo",
+"properties": {
+"retryDelay": {
+"description": "Clients should wait at least this long between retrying the same request.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
"Route": {
"description": "The Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.",
"id": "Route",
diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json
index e059eb0..d4b31b0 100644
--- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json
+++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json
@@ -1754,7 +1754,7 @@
}
}
},
-"revision": "20260123",
+"revision": "20260203",
"rootUrl": "https://developerconnect.googleapis.com/",
"schemas": {
"AccountConnector": {
@@ -3266,27 +3266,16 @@
"DATASTAX",
"DYNATRACE"
],
-"enumDeprecated": [
-false,
-false,
-false,
-true,
-true,
-true,
-true,
-true,
-true
-],
"enumDescriptions": [
"No system provider specified.",
"GitHub provider. Scopes can be found at https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes",
"GitLab provider. Scopes can be found at https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes",
-"Deprecated: This provider is no longer supported. Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"",
-"Deprecated: This provider is no longer supported. Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/",
-"Deprecated: This provider is no longer supported. Rovo provider. Must select the \"rovo\" scope.",
-"Deprecated: This provider is no longer supported. New Relic provider. No scopes are allowed.",
-"Deprecated: This provider is no longer supported. Datastax provider. No scopes are allowed.",
-"Deprecated: This provider is no longer supported. Dynatrace provider."
+"Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"",
+"Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/",
+"Rovo provider. Must select the \"rovo\" scope.",
+"New Relic provider. No scopes are allowed.",
+"Datastax provider. No scopes are allowed.",
+"Dynatrace provider."
],
"type": "string"
}
@@ -3401,27 +3390,16 @@
"DATASTAX",
"DYNATRACE"
],
-"enumDeprecated": [
-false,
-false,
-false,
-true,
-true,
-true,
-true,
-true,
-true
-],
"enumDescriptions": [
"No system provider specified.",
"GitHub provider. Scopes can be found at https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes",
"GitLab provider. Scopes can be found at https://docs.gitlab.com/user/profile/personal_access_tokens/#personal-access-token-scopes",
-"Deprecated: This provider is no longer supported. Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"",
-"Deprecated: This provider is no longer supported. Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/",
-"Deprecated: This provider is no longer supported. Rovo provider. Must select the \"rovo\" scope.",
-"Deprecated: This provider is no longer supported. New Relic provider. No scopes are allowed.",
-"Deprecated: This provider is no longer supported. Datastax provider. No scopes are allowed.",
-"Deprecated: This provider is no longer supported. Dynatrace provider."
+"Google provider. Recommended scopes: \"https://www.googleapis.com/auth/drive.readonly\", \"https://www.googleapis.com/auth/documents.readonly\"",
+"Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/",
+"Rovo provider. Must select the \"rovo\" scope.",
+"New Relic provider. No scopes are allowed.",
+"Datastax provider. No scopes are allowed.",
+"Dynatrace provider."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v4.json b/googleapiclient/discovery_cache/documents/dfareporting.v4.json
index c1361cb..3ad6643 100644
--- a/googleapiclient/discovery_cache/documents/dfareporting.v4.json
+++ b/googleapiclient/discovery_cache/documents/dfareporting.v4.json
@@ -4677,7 +4677,7 @@
]
},
"retransform": {
-"description": "Retransforms a dynamic feed.",
+"description": "Retransforms a dynamic feed. Only draft feeds can be retransformed (i.e. the feed has not been published).",
"flatPath": "studio/dynamicFeeds/{dynamicFeedsId}/retransform",
"httpMethod": "POST",
"id": "dfareporting.dynamicFeeds.retransform",
@@ -4703,7 +4703,7 @@
]
},
"update": {
-"description": "Updates a new dynamic feed.",
+"description": "Updates a new dynamic feed. For draft feeds, only Element can be updated. For published feeds, only FeedSchedule can be updated. Other fields will be ignored.",
"flatPath": "studio/dynamicFeeds",
"httpMethod": "PUT",
"id": "dfareporting.dynamicFeeds.update",
@@ -4725,7 +4725,7 @@
"dynamicProfiles": {
"methods": {
"generateCode": {
-"description": "Generates code for a dynamic profile.",
+"description": "Generates code for a dynamic profile, which will need unescaping.",
"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/generateCode",
"httpMethod": "GET",
"id": "dfareporting.dynamicProfiles.generateCode",
@@ -10465,7 +10465,7 @@
}
}
},
-"revision": "20251023",
+"revision": "20260213",
"rootUrl": "https://dfareporting.googleapis.com/",
"schemas": {
"Account": {
@@ -12090,7 +12090,7 @@
"type": "object"
},
"CartData": {
-"description": " *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788)",
+"description": "Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788)",
"id": "CartData",
"properties": {
"items": {
@@ -15734,7 +15734,7 @@
"type": "object"
},
"DynamicFeed": {
-"description": "Contains dynamic feed information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.",
"id": "DynamicFeed",
"properties": {
"contentSource": {
@@ -15805,7 +15805,7 @@
"type": "object"
},
"DynamicFeedsInsertRequest": {
-"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See",
+"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynamic feed itself don't need the dynamic profile id.",
"id": "DynamicFeedsInsertRequest",
"properties": {
"dynamicFeed": {
@@ -15821,7 +15821,7 @@
"type": "object"
},
"DynamicProfile": {
-"description": "Contains dynamic profile information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.",
"id": "DynamicProfile",
"properties": {
"active": {
@@ -15925,7 +15925,7 @@
"id": "DynamicProfileGenerateCodeResponse",
"properties": {
"code": {
-"description": "Generated code for the dynamic profile.",
+"description": "Generated code for the dynamic profile. The code will need to be unescaped.",
"type": "string"
}
},
@@ -21633,7 +21633,7 @@
"type": "object"
},
"StudioCreative": {
-"description": "Contains studio creative information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.",
"id": "StudioCreative",
"properties": {
"assetIds": {
@@ -21645,7 +21645,7 @@
"type": "array"
},
"backupImageAssetId": {
-"description": "Backup image asset ID of this studio creative.",
+"description": "Backup image asset ID of this studio creative. It is a required field on insertion.",
"format": "int64",
"type": "string"
},
@@ -21734,7 +21734,7 @@
"type": "object"
},
"StudioCreativeAsset": {
-"description": "Contains studio creative asset information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative asset information.",
"id": "StudioCreativeAsset",
"properties": {
"createInfo": {
diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v5.json b/googleapiclient/discovery_cache/documents/dfareporting.v5.json
index 279c28d..1e4e989 100644
--- a/googleapiclient/discovery_cache/documents/dfareporting.v5.json
+++ b/googleapiclient/discovery_cache/documents/dfareporting.v5.json
@@ -4677,7 +4677,7 @@
]
},
"retransform": {
-"description": "Retransforms a dynamic feed.",
+"description": "Retransforms a dynamic feed. Only draft feeds can be retransformed (i.e. the feed has not been published).",
"flatPath": "studio/dynamicFeeds/{dynamicFeedsId}/retransform",
"httpMethod": "POST",
"id": "dfareporting.dynamicFeeds.retransform",
@@ -4703,7 +4703,7 @@
]
},
"update": {
-"description": "Updates a new dynamic feed.",
+"description": "Updates a new dynamic feed. For draft feeds, only Element can be updated. For published feeds, only FeedSchedule can be updated. Other fields will be ignored.",
"flatPath": "studio/dynamicFeeds",
"httpMethod": "PUT",
"id": "dfareporting.dynamicFeeds.update",
@@ -4725,7 +4725,7 @@
"dynamicProfiles": {
"methods": {
"generateCode": {
-"description": "Generates code for a dynamic profile.",
+"description": "Generates code for a dynamic profile, which will need unescaping.",
"flatPath": "studio/dynamicProfiles/{dynamicProfilesId}/generateCode",
"httpMethod": "GET",
"id": "dfareporting.dynamicProfiles.generateCode",
@@ -9432,6 +9432,12 @@
"location": "query",
"type": "string"
},
+"countryDartId": {
+"description": "Optional. Country Dart ID. If not specified, defaults to 256 (US).",
+"format": "int64",
+"location": "query",
+"type": "string"
+},
"id": {
"description": "Required. TV Campaign ID.",
"location": "path",
@@ -9446,6 +9452,33 @@
"pattern": "^[^/]+$",
"required": true,
"type": "string"
+},
+"tvDataProvider": {
+"description": "Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`.",
+"enum": [
+"INVALID_TV_DATA_PROVIDER",
+"IBOPE_AR",
+"IBOPE_BR",
+"IBOPE_CL",
+"IBOPE_CO",
+"TNS_VN",
+"COMSCORE_NATIONAL_US",
+"COMSCORE_CA",
+"SAMBA_AU"
+],
+"enumDescriptions": [
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+""
+],
+"location": "query",
+"type": "string"
}
},
"path": "userprofiles/{+profileId}/tvCampaignDetails/{+id}",
@@ -9475,6 +9508,12 @@
"location": "query",
"type": "string"
},
+"countryDartId": {
+"description": "Optional. Country Dart ID. If not specified, defaults to 256 (US).",
+"format": "int64",
+"location": "query",
+"type": "string"
+},
"name": {
"description": "Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.",
"location": "query",
@@ -9487,6 +9526,33 @@
"pattern": "^[^/]+$",
"required": true,
"type": "string"
+},
+"tvDataProvider": {
+"description": "Optional. TV data provider. If not specified, defaults to `COMSCORE_NATIONAL_US`.",
+"enum": [
+"INVALID_TV_DATA_PROVIDER",
+"IBOPE_AR",
+"IBOPE_BR",
+"IBOPE_CL",
+"IBOPE_CO",
+"TNS_VN",
+"COMSCORE_NATIONAL_US",
+"COMSCORE_CA",
+"SAMBA_AU"
+],
+"enumDescriptions": [
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+""
+],
+"location": "query",
+"type": "string"
}
},
"path": "userprofiles/{+profileId}/tvCampaignSummaries",
@@ -10005,7 +10071,7 @@
}
}
},
-"revision": "20251023",
+"revision": "20260213",
"rootUrl": "https://dfareporting.googleapis.com/",
"schemas": {
"Account": {
@@ -11564,7 +11630,7 @@
"type": "object"
},
"CartData": {
-"description": " *Beta:* This feature is currently in beta. Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788)",
+"description": "Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. Cart data reporting is only supported in SA360. [Learn more](https://support.google.com/sa360/topic/13425788)",
"id": "CartData",
"properties": {
"items": {
@@ -12391,6 +12457,36 @@
"sslEnabled": {
"description": "Whether ad serving supports secure servers in this country.",
"type": "boolean"
+},
+"tvDataProviders": {
+"description": "Output only. The TV data providers supported in this country.",
+"items": {
+"enum": [
+"INVALID_TV_DATA_PROVIDER",
+"IBOPE_AR",
+"IBOPE_BR",
+"IBOPE_CL",
+"IBOPE_CO",
+"TNS_VN",
+"COMSCORE_NATIONAL_US",
+"COMSCORE_CA",
+"SAMBA_AU"
+],
+"enumDescriptions": [
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+""
+],
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
}
},
"type": "object"
@@ -15181,7 +15277,7 @@
"type": "object"
},
"DynamicFeed": {
-"description": "Contains dynamic feed information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic feed information.",
"id": "DynamicFeed",
"properties": {
"contentSource": {
@@ -15252,7 +15348,7 @@
"type": "object"
},
"DynamicFeedsInsertRequest": {
-"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynnamic feed itself don't need the dynamic profile id. See",
+"description": "Dynamic profile ID is required for dynamic feed insert as the current GPA API only can create a dynamic feed under profile context,even though the dynamic feed itself don't need the dynamic profile id.",
"id": "DynamicFeedsInsertRequest",
"properties": {
"dynamicFeed": {
@@ -15268,7 +15364,7 @@
"type": "object"
},
"DynamicProfile": {
-"description": "Contains dynamic profile information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.",
"id": "DynamicProfile",
"properties": {
"active": {
@@ -15372,7 +15468,7 @@
"id": "DynamicProfileGenerateCodeResponse",
"properties": {
"code": {
-"description": "Generated code for the dynamic profile.",
+"description": "Generated code for the dynamic profile. The code will need to be unescaped.",
"type": "string"
}
},
@@ -20504,7 +20600,7 @@
"type": "object"
},
"StudioCreative": {
-"description": "Contains studio creative information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative information.",
"id": "StudioCreative",
"properties": {
"assetIds": {
@@ -20516,7 +20612,7 @@
"type": "array"
},
"backupImageAssetId": {
-"description": "Backup image asset ID of this studio creative.",
+"description": "Backup image asset ID of this studio creative. It is a required field on insertion.",
"format": "int64",
"type": "string"
},
@@ -20605,7 +20701,7 @@
"type": "object"
},
"StudioCreativeAsset": {
-"description": "Contains studio creative asset information.",
+"description": " *Beta:* This API resource is available only to a very limited number of customers. If you'd like to use this resource, please reach out to your Google sales representative. Contains studio creative asset information.",
"id": "StudioCreativeAsset",
"properties": {
"createInfo": {
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
index 5353ed6..fcc5bf4 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
@@ -3599,7 +3599,7 @@
"engines": {
"methods": {
"create": {
-"description": "Creates a Engine.",
+"description": "Creates an Engine.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.create",
@@ -3633,7 +3633,7 @@
]
},
"delete": {
-"description": "Deletes a Engine.",
+"description": "Deletes an Engine.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.engines.delete",
@@ -3659,7 +3659,7 @@
]
},
"get": {
-"description": "Gets a Engine.",
+"description": "Gets an Engine.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.get",
@@ -3684,6 +3684,38 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
+"getIamPolicy": {
+"description": "Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getIamPolicy",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.engines.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite"
+]
+},
"list": {
"description": "Lists all the Engines associated with the project.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines",
@@ -3760,6 +3792,35 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
+},
+"setIamPolicy": {
+"description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.engines.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite"
+]
}
},
"resources": {
@@ -8801,7 +8862,7 @@
}
}
},
-"revision": "20260130",
+"revision": "20260209",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GoogleApiDistribution": {
@@ -12550,14 +12611,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -13180,7 +13243,8 @@
"THIRD_PARTY_FEDERATED",
"THIRD_PARTY_EUA",
"GCNV",
-"GOOGLE_CHAT"
+"GOOGLE_CHAT",
+"GOOGLE_SITES"
],
"enumDescriptions": [
"Default value.",
@@ -13195,7 +13259,8 @@
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
"Connector utilized for End User Authentication features.",
"Google Cloud NetApp Volumes connector.",
-"Google Chat connector."
+"Google Chat connector.",
+"Google Sites connector."
],
"readOnly": true,
"type": "string"
@@ -13688,14 +13753,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -14486,14 +14553,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -14732,6 +14801,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -14740,18 +14810,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -15569,6 +15640,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -15601,13 +15682,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -15639,6 +15724,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -15647,18 +15733,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -16185,6 +16272,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -16200,6 +16291,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -18398,14 +18511,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -19607,14 +19722,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -20367,6 +20484,10 @@
"languageCode": {
"description": "Optional. The language code used for notifications",
"type": "string"
+},
+"regionCode": {
+"description": "Optional. The region code used of the user that subscribed to the alert policy.",
+"type": "string"
}
},
"type": "object"
@@ -22014,14 +22135,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -22417,7 +22540,8 @@
"THIRD_PARTY_FEDERATED",
"THIRD_PARTY_EUA",
"GCNV",
-"GOOGLE_CHAT"
+"GOOGLE_CHAT",
+"GOOGLE_SITES"
],
"enumDescriptions": [
"Default value.",
@@ -22432,7 +22556,8 @@
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
"Connector utilized for End User Authentication features.",
"Google Cloud NetApp Volumes connector.",
-"Google Chat connector."
+"Google Chat connector.",
+"Google Sites connector."
],
"readOnly": true,
"type": "string"
@@ -22447,6 +22572,10 @@
"readOnly": true,
"type": "string"
},
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for the connector."
+},
"dataSource": {
"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
"type": "string"
@@ -22794,6 +22923,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": {
+"description": "Data protection policy config for a connector.",
+"id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy for the connector source."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection content policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaDataStore": {
"description": "DataStore captures global settings and configs at the DataStore level.",
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
@@ -22934,14 +23085,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -23614,14 +23767,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -23916,6 +24071,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -23924,18 +24080,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -24736,6 +24893,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -24768,13 +24935,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -24806,6 +24977,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -24814,18 +24986,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -25086,6 +25259,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -25101,6 +25278,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -25382,6 +25581,13 @@
"description": "Defines a user inputed query.",
"id": "GoogleCloudDiscoveryengineV1alphaQuery",
"properties": {
+"parts": {
+"description": "Query content parts.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPart"
+},
+"type": "array"
+},
"queryId": {
"description": "Output only. Unique Id for the query.",
"readOnly": true,
@@ -25394,6 +25600,137 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaQueryPart": {
+"description": "Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPart",
+"properties": {
+"documentReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference",
+"description": "Other VAIS Document references."
+},
+"driveDocumentReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference",
+"description": "Reference to a Google Drive document."
+},
+"mimeType": {
+"description": "Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is \"text/plain\" for the \"data\" field.",
+"type": "string"
+},
+"personReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference",
+"description": "Reference to a person."
+},
+"text": {
+"description": "Text content.",
+"type": "string"
+},
+"uiJsonPayload": {
+"description": "This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference": {
+"description": "Represents a document reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the reference.",
+"type": "string"
+},
+"displayTitle": {
+"description": "The display title of the reference.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the document data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"iconUri": {
+"description": "The icon uri of the reference.",
+"type": "string"
+},
+"urlForConnector": {
+"description": "Input only. The url_for_connector of the document returned by Federated Search.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference": {
+"description": "Represents a Google Drive document reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the reference.",
+"type": "string"
+},
+"displayTitle": {
+"description": "The display title of the reference.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
+"type": "string"
+},
+"driveId": {
+"description": "The Drive id of the document.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the Drive document data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"iconUri": {
+"description": "The icon uri of the Drive document reference.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference": {
+"description": "Represents a person reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the person.",
+"type": "string"
+},
+"displayName": {
+"description": "The display name of the person.",
+"type": "string"
+},
+"displayPhotoUri": {
+"description": "The display photo url of the person.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
+"type": "string"
+},
+"email": {
+"description": "The email of the person.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the person data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"personId": {
+"description": "The person id of the person.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata",
@@ -25824,6 +26161,11 @@
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
+"numResultsPerDataStore": {
+"description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.",
+"format": "int32",
+"type": "integer"
+},
"offset": {
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
"format": "int32",
@@ -26329,6 +26671,11 @@
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
+},
+"numResults": {
+"description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.",
+"format": "int32",
+"type": "integer"
}
},
"type": "object"
@@ -27627,14 +27974,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -28044,14 +28393,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -28579,14 +28930,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -28825,6 +29178,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -28833,18 +29187,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -29377,6 +29732,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -29409,13 +29774,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -29447,6 +29816,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -29455,18 +29825,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -29654,6 +30025,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -29669,6 +30044,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -30034,6 +30431,11 @@
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
+"numResultsPerDataStore": {
+"description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.",
+"format": "int32",
+"type": "integer"
+},
"offset": {
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
"format": "int32",
@@ -30535,6 +30937,11 @@
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
+},
+"numResults": {
+"description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.",
+"format": "int32",
+"type": "integer"
}
},
"type": "object"
@@ -31369,6 +31776,63 @@
},
"type": "object"
},
+"GoogleIamV1Binding": {
+"description": "Associates `members`, or principals, with a `role`.",
+"id": "GoogleIamV1Binding",
+"properties": {
+"condition": {
+"$ref": "GoogleTypeExpr",
+"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
+},
+"members": {
+"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"role": {
+"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleIamV1Policy": {
+"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:[email protected]\", \"group:[email protected]\", \"domain:google.com\", \"serviceAccount:[email protected]\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:[email protected]\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
+"id": "GoogleIamV1Policy",
+"properties": {
+"bindings": {
+"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
+"items": {
+"$ref": "GoogleIamV1Binding"
+},
+"type": "array"
+},
+"etag": {
+"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
+"format": "byte",
+"type": "string"
+},
+"version": {
+"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleIamV1SetIamPolicyRequest": {
+"description": "Request message for `SetIamPolicy` method.",
+"id": "GoogleIamV1SetIamPolicyRequest",
+"properties": {
+"policy": {
+"$ref": "GoogleIamV1Policy",
+"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
+}
+},
+"type": "object"
+},
"GoogleLongrunningCancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "GoogleLongrunningCancelOperationRequest",
@@ -31674,6 +32138,29 @@
},
"type": "object"
},
+"GoogleTypeExpr": {
+"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
+"id": "GoogleTypeExpr",
+"properties": {
+"description": {
+"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
+"type": "string"
+},
+"expression": {
+"description": "Textual representation of an expression in Common Expression Language syntax.",
+"type": "string"
+},
+"location": {
+"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
+"type": "string"
+},
+"title": {
+"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleTypeTimeZone": {
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "GoogleTypeTimeZone",
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
index e075060..0c459cc 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
@@ -395,6 +395,64 @@
"resources": {
"locations": {
"methods": {
+"completeExternalIdentities": {
+"description": "This method provides suggestions for users and groups managed in an external identity provider, based on the provided prefix.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:completeExternalIdentities",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.completeExternalIdentities",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"entityTypeFilter": {
+"description": "Optional. The type of entities to fetch. If not set, all entity types will be returned.",
+"enum": [
+"ENTITY_TYPE_FILTER_UNSPECIFIED",
+"USERS",
+"GROUPS"
+],
+"enumDescriptions": [
+"Unspecified entity type filter.",
+"Fetch only users.",
+"Fetch only groups."
+],
+"location": "query",
+"type": "string"
+},
+"maxSuggestions": {
+"description": "Optional. The maximum number of user and group results to return. The service may return fewer than this value. If unspecified, at most 6 results will be returned. The limit is distributed as evenly as possible across users and groups. For example, if max_suggestions is 7, the service may return 4 users and 3 groups. If there are fewer suggestions of one type than half the limit, the other type may return more suggestions up to the max_suggestions limit.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"parent": {
+"description": "Required. The parent location resource name, such as `projects/*/locations/global`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"prefixQuery": {
+"description": "Required. The prefix to search for. For users, this prefix is matched against the `primary_email`. For groups, this prefix is matched against the `display_name`. The matching is case-insensitive.",
+"location": "query",
+"type": "string"
+},
+"useScimIdentities": {
+"description": "Optional. Whether to use scim identities for external identity completion. If false, we will call the Microsoft graph API to fetch the external identities.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1alpha/{+parent}:completeExternalIdentities",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.readwrite"
+]
+},
"estimateDataSize": {
"description": "Estimates the data size to be used by a customer.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:estimateDataSize",
@@ -1360,7 +1418,7 @@
],
"parameters": {
"parent": {
-"description": "Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collection_id}/dataConnector",
+"description": "Required. Connector name of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
"required": true,
@@ -4900,7 +4958,7 @@
"engines": {
"methods": {
"create": {
-"description": "Creates a Engine.",
+"description": "Creates an Engine.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.create",
@@ -4934,7 +4992,7 @@
]
},
"delete": {
-"description": "Deletes a Engine.",
+"description": "Deletes an Engine.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.engines.delete",
@@ -4960,7 +5018,7 @@
]
},
"get": {
-"description": "Gets a Engine.",
+"description": "Gets an Engine.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.get",
@@ -4985,6 +5043,38 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
+"getIamPolicy": {
+"description": "Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getIamPolicy",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.engines.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite"
+]
+},
"getWorkspaceSettings": {
"description": "Get Workspace settings for the end user.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getWorkspaceSettings",
@@ -5089,7 +5179,7 @@
]
},
"pause": {
-"description": "Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
+"description": "Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:pause",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.pause",
@@ -5118,7 +5208,7 @@
]
},
"resume": {
-"description": "Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
+"description": "Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:resume",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.resume",
@@ -5146,8 +5236,37 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
+"setIamPolicy": {
+"description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.engines.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite"
+]
+},
"tune": {
-"description": "Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
+"description": "Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:tune",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.tune",
@@ -5400,87 +5519,6 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
-"listAvailableAgentViews": {
-"description": "Lists the data for displaying the Agents under an Assistant which are available to the caller.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:listAvailableAgentViews",
-"httpMethod": "POST",
-"id": "discoveryengine.projects.locations.collections.engines.assistants.listAvailableAgentViews",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"adminView": {
-"description": "Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.",
-"location": "query",
-"type": "boolean"
-},
-"agentOrigin": {
-"description": "Optional. The origin of the Agent.",
-"enum": [
-"AGENT_ORIGIN_UNSPECIFIED",
-"GOOGLE",
-"ORGANIZATION",
-"USER"
-],
-"enumDescriptions": [
-"The origin is unspecified.",
-"Agent defined by Google.",
-"Agent defined by the organization.",
-"Agent defined by the user."
-],
-"location": "query",
-"type": "string"
-},
-"filter": {
-"description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Allowed fields are: * `display_name` * `state` Some examples of filters would be: * `display_name = 'agent_1'` * `display_name = 'agent_1' AND state = ENABLED` For a full description of the filter format, please see https://google.aip.dev/160.",
-"location": "query",
-"type": "string"
-},
-"languageCode": {
-"description": "Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentViews in the response should be translated to this language.",
-"location": "query",
-"type": "string"
-},
-"maxSuggestedPrompts": {
-"description": "Optional. The maximum number of suggested prompts to return per agent.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageSize": {
-"description": "Optional. Maximum number of AgentViews to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableAgentViews must match the call that provided the page token.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$",
-"required": true,
-"type": "string"
-},
-"sortBy": {
-"description": "Optional. The field to sort by. Can have the following values: - display-name: The display name of the agent. - description: The description of the agent. - create-time: The creation time of the agent. - state: The state of the agent.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1alpha/{+parent}:listAvailableAgentViews",
-"response": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
-]
-},
"patch": {
"description": "Updates an Assistant",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}",
@@ -5608,70 +5646,6 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
-"disableAgent": {
-"description": "Disables an Agent. The `state` of the Agent becomes `DISABLED`. Can be called on an Agent in the state `ENABLED` or`SUSPENDED`, otherwise it returns an error.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:disableAgent",
-"httpMethod": "POST",
-"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.disableAgent",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the Agent to disable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$",
-"required": true,
-"type": "string"
-},
-"revisionId": {
-"description": "Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1alpha/{+name}:disableAgent",
-"response": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgent"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
-]
-},
-"enableAgent": {
-"description": "Enables an Agent. The `state` of the Agent becomes `ENABLED`. Can be called on an Agent in the state `DISABLED` or 'SUSPENDED', otherwise it returns an error.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:enableAgent",
-"httpMethod": "POST",
-"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.enableAgent",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the Agent to enable. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$",
-"required": true,
-"type": "string"
-},
-"revisionId": {
-"description": "Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1alpha/{+name}:enableAgent",
-"response": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgent"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
-]
-},
"get": {
"description": "Gets an Agent.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}",
@@ -5699,82 +5673,6 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
-"getAgentView": {
-"description": "Returns a AgentView for a given Agent, which contains additional information about the Agent.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:getAgentView",
-"httpMethod": "GET",
-"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.getAgentView",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"adminView": {
-"description": "Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.",
-"location": "query",
-"type": "boolean"
-},
-"languageCode": {
-"description": "Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.",
-"location": "query",
-"type": "string"
-},
-"maxSuggestedPrompts": {
-"description": "Optional. The maximum number of suggested prompts to return per agent.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"name": {
-"description": "Required. The name of the Agent to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1alpha/{+name}:getAgentView",
-"response": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
-]
-},
-"getIamPolicy": {
-"description": "Gets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:getIamPolicy",
-"httpMethod": "GET",
-"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1alpha/{+resource}:getIamPolicy",
-"response": {
-"$ref": "GoogleIamV1Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
-]
-},
"list": {
"description": "Lists all Agents under an Assistant which were created by the caller.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents",
@@ -5853,68 +5751,6 @@
"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
-},
-"setIamPolicy": {
-"description": "Sets the access control policy for an agent resource. A `NOT_FOUND` error is returned if the resource does not exist. Policy can only contain `roles/discoveryengine.agentUser`, `roles/discoveryengine.agentViewer` and `roles/discoveryengine.agentEditor` roles.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.setIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1alpha/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
-},
-"response": {
-"$ref": "GoogleIamV1Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
-]
-},
-"suspendAgent": {
-"description": "Suspends an Agent. It is still available for viewing but not for use. The `state` of the Agent becomes `SUSPENDED`. Can be called on an Agent in the state `ENABLED`, otherwise it returns an error.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}:suspendAgent",
-"httpMethod": "POST",
-"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.suspendAgent",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the Agent to suspend. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$",
-"required": true,
-"type": "string"
-},
-"suspensionReason": {
-"description": "Required. The reason for suspending the Agent. This will be shown to the users of the Agent.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1alpha/{+name}:suspendAgent",
-"response": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgent"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
-]
}
},
"resources": {
@@ -12414,7 +12250,7 @@
}
}
},
-"revision": "20260130",
+"revision": "20260209",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GoogleApiDistribution": {
@@ -13509,14 +13345,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -13884,7 +13722,8 @@
"THIRD_PARTY_FEDERATED",
"THIRD_PARTY_EUA",
"GCNV",
-"GOOGLE_CHAT"
+"GOOGLE_CHAT",
+"GOOGLE_SITES"
],
"enumDescriptions": [
"Default value.",
@@ -13899,7 +13738,8 @@
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
"Connector utilized for End User Authentication features.",
"Google Cloud NetApp Volumes connector.",
-"Google Chat connector."
+"Google Chat connector.",
+"Google Sites connector."
],
"readOnly": true,
"type": "string"
@@ -14392,14 +14232,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -14984,14 +14826,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -15230,6 +15074,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -15238,18 +15083,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -15605,6 +15451,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -15637,13 +15493,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -15675,6 +15535,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -15683,18 +15544,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -15833,6 +15695,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -15848,6 +15714,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -16368,14 +16256,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -17507,197 +17397,6 @@
},
"type": "object"
},
-"GoogleCloudDiscoveryengineV1alphaAgentView": {
-"description": "The data for displaying an Agent.",
-"id": "GoogleCloudDiscoveryengineV1alphaAgentView",
-"properties": {
-"agentOrigin": {
-"description": "Immutable. The origin of the Agent.",
-"enum": [
-"AGENT_ORIGIN_UNSPECIFIED",
-"GOOGLE",
-"ORGANIZATION",
-"USER"
-],
-"enumDescriptions": [
-"The origin is unspecified.",
-"Agent defined by Google.",
-"Agent defined by the organization.",
-"Agent defined by the user."
-],
-"type": "string"
-},
-"agentSharingState": {
-"description": "Output only. The sharing state of the agent.",
-"enum": [
-"AGENT_SHARING_STATE_UNSPECIFIED",
-"NOT_SHARED",
-"PENDING",
-"SHARED",
-"REJECTED"
-],
-"enumDescriptions": [
-"The sharing state is unspecified.",
-"The agent is not shared.",
-"The agent is pending review.",
-"The agent is shared with other users.",
-"The agent sharing request was rejected."
-],
-"readOnly": true,
-"type": "string"
-},
-"agentType": {
-"description": "Output only. The type of the agent.",
-"enum": [
-"AGENT_TYPE_UNSPECIFIED",
-"NO_CODE",
-"HTTP",
-"ADK",
-"MANAGED",
-"A2A",
-"DIALOGFLOW",
-"LOW_CODE"
-],
-"enumDescriptions": [
-"The agent type is unspecified.",
-"No-code agent.",
-"HTTP agent.",
-"ADK agent.",
-"Google managed agent.",
-"A2A agent.",
-"Dialogflow agent.",
-"Low-code agent."
-],
-"readOnly": true,
-"type": "string"
-},
-"customPlaceholderText": {
-"description": "The custom placeholder text that appears in the text box before the user enters any text.",
-"type": "string"
-},
-"deploymentFailureReason": {
-"description": "The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.",
-"type": "string"
-},
-"description": {
-"description": "Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query and to generate the first version of the steps for the agent that can be modified by the user. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.",
-"type": "string"
-},
-"displayName": {
-"description": "Required. Display name of the agent. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.",
-"type": "string"
-},
-"icon": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgentImage",
-"description": "Optional. The icon that represents the agent on the UI."
-},
-"name": {
-"description": "Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`",
-"type": "string"
-},
-"rejectionReason": {
-"description": "The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.",
-"type": "string"
-},
-"state": {
-"description": "Output only. The state of the Agent.",
-"enum": [
-"STATE_UNSPECIFIED",
-"CONFIGURED",
-"DEPLOYING",
-"DISABLED",
-"DEPLOYMENT_FAILED",
-"PRIVATE",
-"ENABLED",
-"SUSPENDED"
-],
-"enumDescriptions": [
-"The state is unspecified.",
-"The agent is configured, but no deployment triggered yet.",
-"The agent is being deployed.",
-"The agent is available for admins only.",
-"The agent deployment failed.",
-"Agent is available only to its creator..",
-"Agent is available for users who have access.",
-"Agent is temporarily unavailable, though visible to users who have access."
-],
-"readOnly": true,
-"type": "string"
-},
-"suggestedPrompts": {
-"description": "Optional. The suggested prompts for the agent, to be shown on the agent landing page.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt"
-},
-"type": "array"
-},
-"suspensionReason": {
-"description": "The reason why the agent was suspended. Only set if the state is SUSPENDED.",
-"type": "string"
-},
-"updateTime": {
-"description": "Output only. The timestamp when the agent was last updated.",
-"format": "google-datetime",
-"readOnly": true,
-"type": "string"
-},
-"userAnnotations": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaUserAnnotations",
-"description": "Optional. Per-user annotations of the current caller for the agent."
-},
-"userPermissions": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions",
-"description": "The permissions of the user for this Agent."
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt": {
-"description": "A suggested prompt for the agent, to be shown on the agent landing page.",
-"id": "GoogleCloudDiscoveryengineV1alphaAgentViewSuggestedPrompt",
-"properties": {
-"text": {
-"description": "Required. The text of the suggested prompt. The language of this is either Agent.language_code, or ListAvailableAgentViewsRequest.language_code if translations are enabled.",
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions": {
-"description": "The permissions of the user on an Agent.",
-"id": "GoogleCloudDiscoveryengineV1alphaAgentViewUserPermissions",
-"properties": {
-"canDelete": {
-"description": "If the user can delete this Agent.",
-"type": "boolean"
-},
-"canEdit": {
-"description": "If the user can edit this Agent.",
-"type": "boolean"
-},
-"canProposeUsers": {
-"description": "If the user can propose other users to share the Agent with.",
-"type": "boolean"
-},
-"canRequestReview": {
-"description": "If the user can request a review for this Agent.",
-"type": "boolean"
-},
-"canRun": {
-"description": "If the user can run this Agent.",
-"type": "boolean"
-},
-"canView": {
-"description": "If the user can view the source of this Agent.",
-"type": "boolean"
-},
-"canWithdraw": {
-"description": "If the user can withdraw this Agent.",
-"type": "boolean"
-}
-},
-"type": "object"
-},
"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": {
"description": "The connector level alert config.",
"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig",
@@ -17766,6 +17465,10 @@
"languageCode": {
"description": "Optional. The language code used for notifications",
"type": "string"
+},
+"regionCode": {
+"description": "Optional. The region code used of the user that subscribed to the alert policy.",
+"type": "string"
}
},
"type": "object"
@@ -20242,6 +19945,14 @@
"description": "Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "The date when the subscription is terminated earlier than the expiration date."
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed subscription end date."
@@ -20281,13 +19992,15 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"DEACTIVATING"
],
"enumDescriptions": [
"The BillingAccountLicenseConfig does not exist. Default value. Do not use.",
"The BillingAccountLicenseConfig is active and being used.",
"The BillingAccountLicenseConfig has expired.",
-"The BillingAccountLicenseConfig has not started yet, and its start date is in the future."
+"The BillingAccountLicenseConfig has not started yet, and its start date is in the future.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -20328,6 +20041,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -20336,18 +20050,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -21079,6 +20794,20 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse": {
+"description": "Response message for CompletionService.CompleteExternalIdentities.",
+"id": "GoogleCloudDiscoveryengineV1alphaCompleteExternalIdentitiesResponse",
+"properties": {
+"externalIdentities": {
+"description": "The list of external identities that match the query.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentity"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": {
"description": "Response message for CompletionService.CompleteQuery method.",
"id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse",
@@ -21514,14 +21243,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -22179,7 +21910,8 @@
"THIRD_PARTY_FEDERATED",
"THIRD_PARTY_EUA",
"GCNV",
-"GOOGLE_CHAT"
+"GOOGLE_CHAT",
+"GOOGLE_SITES"
],
"enumDescriptions": [
"Default value.",
@@ -22194,7 +21926,8 @@
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
"Connector utilized for End User Authentication features.",
"Google Cloud NetApp Volumes connector.",
-"Google Chat connector."
+"Google Chat connector.",
+"Google Sites connector."
],
"readOnly": true,
"type": "string"
@@ -22209,6 +21942,10 @@
"readOnly": true,
"type": "string"
},
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for the connector."
+},
"dataSource": {
"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
"type": "string"
@@ -22556,6 +22293,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": {
+"description": "Data protection policy config for a connector.",
+"id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy for the connector source."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection content policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaDataStore": {
"description": "DataStore captures global settings and configs at the DataStore level.",
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
@@ -22696,14 +22455,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -23640,14 +23401,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -23942,6 +23705,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -23950,18 +23714,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -24219,6 +23984,54 @@
"properties": {},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaExternalIdentity": {
+"description": "External identity representing either a user or group. This user or group is from an external identity provider (IdP).",
+"id": "GoogleCloudDiscoveryengineV1alphaExternalIdentity",
+"properties": {
+"displayName": {
+"description": "The display name of the user or group.",
+"type": "string"
+},
+"externalId": {
+"description": "The unique 3P ID(external_id) of the entity (user or group).",
+"type": "string"
+},
+"groupMetadata": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata",
+"description": "Metadata corresponding to the external user."
+},
+"userMetadata": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata",
+"description": "Metadata corresponding to the external user."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata": {
+"description": "Metadata corresponding to the external group.",
+"id": "GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata",
+"properties": {},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata": {
+"description": "Metadata corresponding to the external user.",
+"id": "GoogleCloudDiscoveryengineV1alphaExternalIdentityUserMetadata",
+"properties": {
+"familyName": {
+"description": "The user's family name.",
+"type": "string"
+},
+"givenName": {
+"description": "The user's given name.",
+"type": "string"
+},
+"primaryEmail": {
+"description": "The user's primary email address.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaFactChunk": {
"description": "Fact Chunk.",
"id": "GoogleCloudDiscoveryengineV1alphaFactChunk",
@@ -24693,17 +24506,6 @@
},
"type": "object"
},
-"GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse": {
-"description": "Response message for the AgentService.GetAgentView method.",
-"id": "GoogleCloudDiscoveryengineV1alphaGetAgentViewResponse",
-"properties": {
-"agentView": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgentView",
-"description": "The data for displaying an Agent."
-}
-},
-"type": "object"
-},
"GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse": {
"description": "Response message for DataConnectorService.GetConnectorSecret.",
"id": "GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse",
@@ -25610,6 +25412,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -25642,13 +25454,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -25680,6 +25496,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -25688,18 +25505,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -25776,24 +25594,6 @@
},
"type": "object"
},
-"GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse": {
-"description": "Response message for the AgentService.ListAvailableAgentViews method.",
-"id": "GoogleCloudDiscoveryengineV1alphaListAvailableAgentViewsResponse",
-"properties": {
-"agentViews": {
-"description": "The agent sources visible to the caller under the parent Assistant.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaAgentView"
-},
-"type": "array"
-},
-"nextPageToken": {
-"description": "A token that can be sent as ListAvailableAgentViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
-"type": "string"
-}
-},
-"type": "object"
-},
"GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse": {
"description": "Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.",
"id": "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse",
@@ -26644,6 +26444,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -26659,6 +26463,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -27086,6 +26912,13 @@
"description": "Defines a user inputed query.",
"id": "GoogleCloudDiscoveryengineV1alphaQuery",
"properties": {
+"parts": {
+"description": "Query content parts.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPart"
+},
+"type": "array"
+},
"queryId": {
"description": "Output only. Unique Id for the query.",
"readOnly": true,
@@ -27167,6 +27000,137 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaQueryPart": {
+"description": "Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPart",
+"properties": {
+"documentReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference",
+"description": "Other VAIS Document references."
+},
+"driveDocumentReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference",
+"description": "Reference to a Google Drive document."
+},
+"mimeType": {
+"description": "Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is \"text/plain\" for the \"data\" field.",
+"type": "string"
+},
+"personReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference",
+"description": "Reference to a person."
+},
+"text": {
+"description": "Text content.",
+"type": "string"
+},
+"uiJsonPayload": {
+"description": "This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference": {
+"description": "Represents a document reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the reference.",
+"type": "string"
+},
+"displayTitle": {
+"description": "The display title of the reference.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the document data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"iconUri": {
+"description": "The icon uri of the reference.",
+"type": "string"
+},
+"urlForConnector": {
+"description": "Input only. The url_for_connector of the document returned by Federated Search.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference": {
+"description": "Represents a Google Drive document reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the reference.",
+"type": "string"
+},
+"displayTitle": {
+"description": "The display title of the reference.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
+"type": "string"
+},
+"driveId": {
+"description": "The Drive id of the document.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the Drive document data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"iconUri": {
+"description": "The icon uri of the Drive document reference.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference": {
+"description": "Represents a person reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the person.",
+"type": "string"
+},
+"displayName": {
+"description": "The display name of the person.",
+"type": "string"
+},
+"displayPhotoUri": {
+"description": "The display photo url of the person.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
+"type": "string"
+},
+"email": {
+"description": "The email of the person.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the person data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"personId": {
+"description": "The person id of the person.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaRankRequest": {
"description": "Request message for RankService.Rank method.",
"id": "GoogleCloudDiscoveryengineV1alphaRankRequest",
@@ -28200,6 +28164,11 @@
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
+"numResultsPerDataStore": {
+"description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.",
+"format": "int32",
+"type": "integer"
+},
"offset": {
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
"format": "int32",
@@ -28705,6 +28674,11 @@
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
+},
+"numResults": {
+"description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.",
+"format": "int32",
+"type": "integer"
}
},
"type": "object"
@@ -29998,14 +29972,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -30462,6 +30438,10 @@
"description": "Request for the AssistantService.StreamAssist method.",
"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest",
"properties": {
+"actionSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec",
+"description": "Optional. Specification of actions for the request."
+},
"generationSpec": {
"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec",
"description": "Optional. Specification of the generation configuration for the request."
@@ -30485,6 +30465,17 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec": {
+"description": "Specification of actions for the request.",
+"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestActionSpec",
+"properties": {
+"actionDisabled": {
+"description": "Optional. If true, actions will not be served for the request. This only works for enterprise edition.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec": {
"description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.",
"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec",
@@ -30996,21 +30987,6 @@
},
"type": "object"
},
-"GoogleCloudDiscoveryengineV1alphaUserAnnotations": {
-"description": "Per-user annotations for an Agent, based on UserAnnotation.",
-"id": "GoogleCloudDiscoveryengineV1alphaUserAnnotations",
-"properties": {
-"pinned": {
-"description": "Optional. Whether the agent is pinned, pinned agent will be displayed on the top of the agent list.",
-"type": "boolean"
-},
-"viewed": {
-"description": "Optional. Whether the agent has been viewed by the user.",
-"type": "boolean"
-}
-},
-"type": "object"
-},
"GoogleCloudDiscoveryengineV1alphaUserEvent": {
"description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.",
"id": "GoogleCloudDiscoveryengineV1alphaUserEvent",
@@ -31511,14 +31487,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -32503,14 +32481,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -32920,14 +32900,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -33455,14 +33437,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -33701,6 +33685,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -33709,18 +33694,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -34253,6 +34239,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -34285,13 +34281,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -34323,6 +34323,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -34331,18 +34332,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -34530,6 +34532,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -34545,6 +34551,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -34910,6 +34938,11 @@
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
+"numResultsPerDataStore": {
+"description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.",
+"format": "int32",
+"type": "integer"
+},
"offset": {
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
"format": "int32",
@@ -35411,6 +35444,11 @@
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
+},
+"numResults": {
+"description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.",
+"format": "int32",
+"type": "integer"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
index 5275756..7fb9798 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
@@ -3448,7 +3448,7 @@
"engines": {
"methods": {
"create": {
-"description": "Creates a Engine.",
+"description": "Creates an Engine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.create",
@@ -3482,7 +3482,7 @@
]
},
"delete": {
-"description": "Deletes a Engine.",
+"description": "Deletes an Engine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "DELETE",
"id": "discoveryengine.projects.locations.collections.engines.delete",
@@ -3508,7 +3508,7 @@
]
},
"get": {
-"description": "Gets a Engine.",
+"description": "Gets an Engine.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}",
"httpMethod": "GET",
"id": "discoveryengine.projects.locations.collections.engines.get",
@@ -3533,6 +3533,38 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
+"getIamPolicy": {
+"description": "Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:getIamPolicy",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.engines.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite"
+]
+},
"list": {
"description": "Lists all the Engines associated with the project.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines",
@@ -3611,7 +3643,7 @@
]
},
"pause": {
-"description": "Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
+"description": "Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:pause",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.pause",
@@ -3640,7 +3672,7 @@
]
},
"resume": {
-"description": "Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
+"description": "Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:resume",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.resume",
@@ -3668,8 +3700,37 @@
"https://www.googleapis.com/auth/discoveryengine.readwrite"
]
},
+"setIamPolicy": {
+"description": "Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.engines.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite"
+]
+},
"tune": {
-"description": "Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
+"description": "Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:tune",
"httpMethod": "POST",
"id": "discoveryengine.projects.locations.collections.engines.tune",
@@ -9106,7 +9167,7 @@
}
}
},
-"revision": "20260130",
+"revision": "20260209",
"rootUrl": "https://discoveryengine.googleapis.com/",
"schemas": {
"GoogleApiDistribution": {
@@ -10201,14 +10262,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -10576,7 +10639,8 @@
"THIRD_PARTY_FEDERATED",
"THIRD_PARTY_EUA",
"GCNV",
-"GOOGLE_CHAT"
+"GOOGLE_CHAT",
+"GOOGLE_SITES"
],
"enumDescriptions": [
"Default value.",
@@ -10591,7 +10655,8 @@
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
"Connector utilized for End User Authentication features.",
"Google Cloud NetApp Volumes connector.",
-"Google Chat connector."
+"Google Chat connector.",
+"Google Sites connector."
],
"readOnly": true,
"type": "string"
@@ -11084,14 +11149,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -11676,14 +11743,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -11922,6 +11991,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -11930,18 +12000,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -12297,6 +12368,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -12329,13 +12410,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -12367,6 +12452,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -12375,18 +12461,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -12525,6 +12612,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -12540,6 +12631,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -13060,14 +13173,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -13701,6 +13816,10 @@
"languageCode": {
"description": "Optional. The language code used for notifications",
"type": "string"
+},
+"regionCode": {
+"description": "Optional. The region code used of the user that subscribed to the alert policy.",
+"type": "string"
}
},
"type": "object"
@@ -15348,14 +15467,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -15751,7 +15872,8 @@
"THIRD_PARTY_FEDERATED",
"THIRD_PARTY_EUA",
"GCNV",
-"GOOGLE_CHAT"
+"GOOGLE_CHAT",
+"GOOGLE_SITES"
],
"enumDescriptions": [
"Default value.",
@@ -15766,7 +15888,8 @@
"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
"Connector utilized for End User Authentication features.",
"Google Cloud NetApp Volumes connector.",
-"Google Chat connector."
+"Google Chat connector.",
+"Google Sites connector."
],
"readOnly": true,
"type": "string"
@@ -15781,6 +15904,10 @@
"readOnly": true,
"type": "string"
},
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for the connector."
+},
"dataSource": {
"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
"type": "string"
@@ -16128,6 +16255,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy": {
+"description": "Data protection policy config for a connector.",
+"id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy for the connector source."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection content policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaDataStore": {
"description": "DataStore captures global settings and configs at the DataStore level.",
"id": "GoogleCloudDiscoveryengineV1alphaDataStore",
@@ -16268,14 +16417,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -16948,14 +17099,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -17250,6 +17403,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -17258,18 +17412,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -18070,6 +18225,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -18102,13 +18267,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -18140,6 +18309,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -18148,18 +18318,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -18420,6 +18591,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -18435,6 +18610,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -18716,6 +18913,13 @@
"description": "Defines a user inputed query.",
"id": "GoogleCloudDiscoveryengineV1alphaQuery",
"properties": {
+"parts": {
+"description": "Query content parts.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPart"
+},
+"type": "array"
+},
"queryId": {
"description": "Output only. Unique Id for the query.",
"readOnly": true,
@@ -18728,6 +18932,137 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1alphaQueryPart": {
+"description": "Represents a part or the whole of a content, used to represent a query. A query can be made up of multiple parts.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPart",
+"properties": {
+"documentReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference",
+"description": "Other VAIS Document references."
+},
+"driveDocumentReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference",
+"description": "Reference to a Google Drive document."
+},
+"mimeType": {
+"description": "Optional. The IANA standard MIME type of the data. See https://www.iana.org/assignments/media-types/media-types.xhtml. This field is optional. If not set, the default assumed MIME type is \"text/plain\" for the \"data\" field.",
+"type": "string"
+},
+"personReference": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference",
+"description": "Reference to a person."
+},
+"text": {
+"description": "Text content.",
+"type": "string"
+},
+"uiJsonPayload": {
+"description": "This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference": {
+"description": "Represents a document reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartDocumentReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the reference.",
+"type": "string"
+},
+"displayTitle": {
+"description": "The display title of the reference.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the document data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"iconUri": {
+"description": "The icon uri of the reference.",
+"type": "string"
+},
+"urlForConnector": {
+"description": "Input only. The url_for_connector of the document returned by Federated Search.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference": {
+"description": "Represents a Google Drive document reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartDriveDocumentReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the reference.",
+"type": "string"
+},
+"displayTitle": {
+"description": "The display title of the reference.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the document. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
+"type": "string"
+},
+"driveId": {
+"description": "The Drive id of the document.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the Drive document data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"iconUri": {
+"description": "The icon uri of the Drive document reference.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference": {
+"description": "Represents a person reference.",
+"id": "GoogleCloudDiscoveryengineV1alphaQueryPartPersonReference",
+"properties": {
+"destinationUri": {
+"description": "The destination uri of the person.",
+"type": "string"
+},
+"displayName": {
+"description": "The display name of the person.",
+"type": "string"
+},
+"displayPhotoUri": {
+"description": "The display photo url of the person.",
+"type": "string"
+},
+"documentName": {
+"description": "The full resource name of the person. Format: `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
+"type": "string"
+},
+"email": {
+"description": "The email of the person.",
+"type": "string"
+},
+"fileId": {
+"description": "Output only. The file id of the person data stored in the session context files.",
+"readOnly": true,
+"type": "string"
+},
+"personId": {
+"description": "The person id of the person.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": {
"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.",
"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata",
@@ -19158,6 +19493,11 @@
"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
+"numResultsPerDataStore": {
+"description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.",
+"format": "int32",
+"type": "integer"
+},
"offset": {
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
"format": "int32",
@@ -19663,6 +20003,11 @@
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
+},
+"numResults": {
+"description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.",
+"format": "int32",
+"type": "integer"
}
},
"type": "object"
@@ -23966,14 +24311,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -24645,14 +24992,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -25397,14 +25746,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -25643,6 +25994,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -25651,18 +26003,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
},
@@ -26667,6 +27020,16 @@
"description": "Optional. Whether the license config should be auto renewed when it reaches the end date.",
"type": "boolean"
},
+"earlyTerminated": {
+"description": "Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.",
+"readOnly": true,
+"type": "boolean"
+},
+"earlyTerminationDate": {
+"$ref": "GoogleTypeDate",
+"description": "Output only. The date when the subscription is terminated earlier than the expiration date.",
+"readOnly": true
+},
"endDate": {
"$ref": "GoogleTypeDate",
"description": "Optional. The planed end date."
@@ -26699,13 +27062,17 @@
"STATE_UNSPECIFIED",
"ACTIVE",
"EXPIRED",
-"NOT_STARTED"
+"NOT_STARTED",
+"WITHDRAWN",
+"DEACTIVATING"
],
"enumDescriptions": [
"Default value. The license config does not exist.",
"The license config is effective and being used.",
"The license config has expired.",
-"The license config has not started yet, and its start date is in the future."
+"The license config has not started yet, and its start date is in the future.",
+"This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.",
+"The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first."
],
"readOnly": true,
"type": "string"
@@ -26737,6 +27104,7 @@
"SUBSCRIPTION_TIER_AGENTSPACE_STARTER",
"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS",
"SUBSCRIPTION_TIER_ENTERPRISE",
+"SUBSCRIPTION_TIER_ENTERPRISE_EMERGING",
"SUBSCRIPTION_TIER_EDU",
"SUBSCRIPTION_TIER_EDU_PRO",
"SUBSCRIPTION_TIER_EDU_EMERGING",
@@ -26745,18 +27113,19 @@
],
"enumDescriptions": [
"Default value.",
-"Search tier. Search tier can access VAIS search features and NotebookLM features.",
-"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.",
+"Search tier. Search tier can access Vertex AI Search features and NotebookLM features.",
+"Gemini Enterprise Plus tier.",
"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.",
-"Frontline worker tier.",
-"Agentspace Starter tier.",
-"Agentspace Business tier.",
-"Enterprise tier.",
-"EDU tier.",
-"EDU Pro tier.",
-"EDU emerging market tier.",
-"EDU Pro emerging market tier.",
-"Frontline starter tier."
+"Gemini Frontline worker tier.",
+"Gemini Business Starter tier.",
+"Gemini Business tier.",
+"Gemini Enterprise Standard tier.",
+"Gemini Enterprise Standard tier for emerging markets.",
+"Gemini Enterprise EDU tier.",
+"Gemini Enterprise EDU Pro tier.",
+"Gemini Enterprise EDU tier for emerging market only.",
+"Gemini Enterprise EDU Pro tier for emerging market.",
+"Gemini Frontline Starter tier."
],
"type": "string"
}
@@ -27438,6 +27807,10 @@
"description": "Configuration for NotebookLM.",
"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
"properties": {
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for NotebookLM."
+},
"modelArmorConfig": {
"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
@@ -27453,6 +27826,28 @@
},
"type": "object"
},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy": {
+"description": "Data protection policy config for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicy",
+"properties": {
+"sensitiveDataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"description": "Optional. The sensitive data protection policy."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy": {
+"description": "Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigDataProtectionPolicySensitiveDataProtectionPolicy",
+"properties": {
+"policy": {
+"description": "Optional. The Sensitive Data Protection policy resource name.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
@@ -28455,6 +28850,11 @@
"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
},
+"numResultsPerDataStore": {
+"description": "Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.data_store_specs.num_results if provided, otherwise there is no limit.",
+"format": "int32",
+"type": "integer"
+},
"offset": {
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
"format": "int32",
@@ -28956,6 +29356,11 @@
"filter": {
"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
"type": "string"
+},
+"numResults": {
+"description": "Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the SearchRequest.num_results_per_data_store if provided, otherwise there is no limit. If both this field and SearchRequest.num_results_per_data_store are specified, this field will be used.",
+"format": "int32",
+"type": "integer"
}
},
"type": "object"
@@ -30241,14 +30646,16 @@
"SOLUTION_TYPE_RECOMMENDATION",
"SOLUTION_TYPE_SEARCH",
"SOLUTION_TYPE_CHAT",
-"SOLUTION_TYPE_GENERATIVE_CHAT"
+"SOLUTION_TYPE_GENERATIVE_CHAT",
+"SOLUTION_TYPE_AI_MODE"
],
"enumDescriptions": [
"Default value.",
"Used for Recommendations AI.",
"Used for Discovery Search.",
"Used for use cases related to the Generative AI agent.",
-"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.",
+"Used for AI Mode."
],
"type": "string"
},
@@ -31318,6 +31725,63 @@
},
"type": "object"
},
+"GoogleIamV1Binding": {
+"description": "Associates `members`, or principals, with a `role`.",
+"id": "GoogleIamV1Binding",
+"properties": {
+"condition": {
+"$ref": "GoogleTypeExpr",
+"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
+},
+"members": {
+"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"role": {
+"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleIamV1Policy": {
+"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:[email protected]\", \"group:[email protected]\", \"domain:google.com\", \"serviceAccount:[email protected]\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:[email protected]\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
+"id": "GoogleIamV1Policy",
+"properties": {
+"bindings": {
+"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
+"items": {
+"$ref": "GoogleIamV1Binding"
+},
+"type": "array"
+},
+"etag": {
+"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
+"format": "byte",
+"type": "string"
+},
+"version": {
+"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleIamV1SetIamPolicyRequest": {
+"description": "Request message for `SetIamPolicy` method.",
+"id": "GoogleIamV1SetIamPolicyRequest",
+"properties": {
+"policy": {
+"$ref": "GoogleIamV1Policy",
+"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
+}
+},
+"type": "object"
+},
"GoogleLongrunningCancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "GoogleLongrunningCancelOperationRequest",
@@ -31623,6 +32087,29 @@
},
"type": "object"
},
+"GoogleTypeExpr": {
+"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
+"id": "GoogleTypeExpr",
+"properties": {
+"description": {
+"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
+"type": "string"
+},
+"expression": {
+"description": "Textual representation of an expression in Common Expression Language syntax.",
+"type": "string"
+},
+"location": {
+"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
+"type": "string"
+},
+"title": {
+"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleTypeTimeZone": {
"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
"id": "GoogleTypeTimeZone",
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
index 6d48f07..eba75f4 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
@@ -7981,7 +7981,7 @@
}
}
},
-"revision": "20260107",
+"revision": "20260210",
"rootUrl": "https://displayvideo.googleapis.com/",
"schemas": {
"ActivateManualTriggerRequest": {
@@ -14431,16 +14431,19 @@
"id": "ImageAsset",
"properties": {
"fileSize": {
-"description": "File size of the image asset in bytes.",
+"description": "Output only. File size of the image asset in bytes.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"fullSize": {
"$ref": "Dimensions",
-"description": "Metadata for this image at its original size."
+"description": "Output only. Metadata for this image at its original size.",
+"readOnly": true
},
"mimeType": {
-"description": "MIME type of the image asset.",
+"description": "Output only. MIME type of the image asset.",
+"readOnly": true,
"type": "string"
}
},
@@ -20051,7 +20054,8 @@
"id": "YoutubeVideoDetails",
"properties": {
"id": {
-"description": "The YouTube video ID which can be searched on YouTube webpage.",
+"description": "Output only. The YouTube video ID which can be searched on YouTube webpage.",
+"readOnly": true,
"type": "string"
},
"unavailableReason": {
@@ -20067,6 +20071,11 @@
"The video is deleted."
],
"type": "string"
+},
+"videoAssetId": {
+"description": "Required. The YouTube video asset id. This is ad_asset.ad_asset_id.",
+"format": "int64",
+"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json
index 3c60470..af3901a 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json
@@ -8156,7 +8156,7 @@
}
}
},
-"revision": "20260204",
+"revision": "20260212",
"rootUrl": "https://displayvideo.googleapis.com/",
"schemas": {
"ActiveViewVideoViewabilityMetricConfig": {
@@ -8279,7 +8279,7 @@
"id": "AdGroup",
"properties": {
"adGroupFormat": {
-"description": "The format of the ads in the ad group.",
+"description": "Required. The format of the ads in the ad group.",
"enum": [
"AD_GROUP_FORMAT_UNSPECIFIED",
"AD_GROUP_FORMAT_IN_STREAM",
@@ -8305,25 +8305,27 @@
"type": "string"
},
"adGroupId": {
-"description": "The unique ID of the ad group. Assigned by the system.",
+"description": "Output only. The unique ID of the ad group. Assigned by the system.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"advertiserId": {
-"description": "The unique ID of the advertiser the ad group belongs to.",
+"description": "Output only. The unique ID of the advertiser the ad group belongs to.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"bidStrategy": {
"$ref": "BiddingStrategy",
-"description": "The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy."
+"description": "Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy."
},
"displayName": {
-"description": "The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.",
+"description": "Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.",
"type": "string"
},
"entityStatus": {
-"description": "Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.",
+"description": "Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
@@ -8343,21 +8345,22 @@
"type": "string"
},
"lineItemId": {
-"description": "The unique ID of the line item that the ad group belongs to.",
+"description": "Required. The unique ID of the line item that the ad group belongs to.",
"format": "int64",
"type": "string"
},
"name": {
-"description": "The resource name of the ad group.",
+"description": "Output only. Identifier. The resource name of the ad group.",
+"readOnly": true,
"type": "string"
},
"productFeedData": {
"$ref": "ProductFeedData",
-"description": "The settings of the product feed in this ad group."
+"description": "Optional. The settings of the product feed in this ad group."
},
"targetingExpansion": {
"$ref": "TargetingExpansionConfig",
-"description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group."
+"description": "Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group."
}
},
"type": "object"
@@ -8383,15 +8386,17 @@
"readOnly": true
},
"adUrls": {
-"description": "List of URLs used by the ad.",
+"description": "Output only. List of URLs used by the ad.",
"items": {
"$ref": "AdUrl"
},
+"readOnly": true,
"type": "array"
},
"advertiserId": {
-"description": "Required. The unique ID of the advertiser the ad belongs to.",
+"description": "Output only. The unique ID of the advertiser the ad belongs to.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"audioAd": {
@@ -16962,16 +16967,19 @@
"id": "ImageAsset",
"properties": {
"fileSize": {
-"description": "File size of the image asset in bytes.",
+"description": "Output only. File size of the image asset in bytes.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"fullSize": {
"$ref": "Dimensions",
-"description": "Metadata for this image at its original size."
+"description": "Output only. Metadata for this image at its original size.",
+"readOnly": true
},
"mimeType": {
-"description": "MIME type of the image asset.",
+"description": "Output only. MIME type of the image asset.",
+"readOnly": true,
"type": "string"
}
},
@@ -22488,7 +22496,8 @@
"id": "YoutubeVideoDetails",
"properties": {
"id": {
-"description": "The YouTube video ID which can be searched on YouTube webpage.",
+"description": "Output only. The YouTube video ID which can be searched on YouTube webpage.",
+"readOnly": true,
"type": "string"
},
"unavailableReason": {
@@ -22504,6 +22513,11 @@
"The video is deleted."
],
"type": "string"
+},
+"videoAssetId": {
+"description": "Required. The YouTube video asset id. This is ad_asset.ad_asset_id.",
+"format": "int64",
+"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json
index ec17528..cd4d3f7 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json
@@ -9925,7 +9925,7 @@
}
}
},
-"revision": "20260127",
+"revision": "20260212",
"rootUrl": "https://displayvideo.googleapis.com/",
"schemas": {
"ActiveViewVideoViewabilityMetricConfig": {
@@ -10104,7 +10104,7 @@
"id": "AdGroup",
"properties": {
"adGroupFormat": {
-"description": "The format of the ads in the ad group.",
+"description": "Required. The format of the ads in the ad group.",
"enum": [
"AD_GROUP_FORMAT_UNSPECIFIED",
"AD_GROUP_FORMAT_IN_STREAM",
@@ -10130,25 +10130,27 @@
"type": "string"
},
"adGroupId": {
-"description": "The unique ID of the ad group. Assigned by the system.",
+"description": "Output only. The unique ID of the ad group. Assigned by the system.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"advertiserId": {
-"description": "The unique ID of the advertiser the ad group belongs to.",
+"description": "Output only. The unique ID of the advertiser the ad group belongs to.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"bidStrategy": {
"$ref": "BiddingStrategy",
-"description": "The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy."
+"description": "Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy."
},
"displayName": {
-"description": "The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.",
+"description": "Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.",
"type": "string"
},
"entityStatus": {
-"description": "Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.",
+"description": "Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
@@ -10168,21 +10170,22 @@
"type": "string"
},
"lineItemId": {
-"description": "The unique ID of the line item that the ad group belongs to.",
+"description": "Required. The unique ID of the line item that the ad group belongs to.",
"format": "int64",
"type": "string"
},
"name": {
-"description": "The resource name of the ad group.",
+"description": "Output only. Identifier. The resource name of the ad group.",
+"readOnly": true,
"type": "string"
},
"productFeedData": {
"$ref": "ProductFeedData",
-"description": "The settings of the product feed in this ad group."
+"description": "Optional. The settings of the product feed in this ad group."
},
"targetingExpansion": {
"$ref": "TargetingExpansionConfig",
-"description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group."
+"description": "Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group."
}
},
"type": "object"
@@ -10198,7 +10201,7 @@
"type": "string"
},
"adGroupId": {
-"description": "The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.",
+"description": "Required. The unique ID of the ad group that the ad belongs to.",
"format": "int64",
"type": "string"
},
@@ -10208,10 +10211,11 @@
"readOnly": true
},
"adUrls": {
-"description": "List of URLs used by the ad.",
+"description": "Output only. List of URLs used by the ad.",
"items": {
"$ref": "AdUrl"
},
+"readOnly": true,
"type": "array"
},
"advertiserId": {
@@ -10222,22 +10226,25 @@
},
"audioAd": {
"$ref": "AudioAd",
-"description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives."
+"description": "Output only. Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.",
+"readOnly": true
},
"bumperAd": {
"$ref": "BumperAd",
-"description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach."
+"description": "Output only. Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.",
+"readOnly": true
},
"displayName": {
-"description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.",
+"description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.",
"type": "string"
},
"displayVideoSourceAd": {
"$ref": "DisplayVideoSourceAd",
-"description": "Details of an ad sourced from a Display & Video 360 creative."
+"description": "Output only. Details of an ad sourced from a Display & Video 360 creative.",
+"readOnly": true
},
"entityStatus": {
-"description": "The entity status of the ad.",
+"description": "Required. The entity status of the ad.",
"enum": [
"ENTITY_STATUS_UNSPECIFIED",
"ENTITY_STATUS_ACTIVE",
@@ -10258,11 +10265,13 @@
},
"inStreamAd": {
"$ref": "InStreamAd",
-"description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives."
+"description": "Output only. Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.",
+"readOnly": true
},
"mastheadAd": {
"$ref": "MastheadAd",
-"description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)."
+"description": "Output only. Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).",
+"readOnly": true
},
"name": {
"description": "Output only. The resource name of the ad.",
@@ -10271,15 +10280,18 @@
},
"nonSkippableAd": {
"$ref": "NonSkippableAd",
-"description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives."
+"description": "Output only. Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.",
+"readOnly": true
},
"videoDiscoverAd": {
"$ref": "VideoDiscoveryAd",
-"description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery."
+"description": "Output only. Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.",
+"readOnly": true
},
"videoPerformanceAd": {
"$ref": "VideoPerformanceAd",
-"description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product."
+"description": "Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.",
+"readOnly": true
}
},
"type": "object"
@@ -18951,16 +18963,19 @@
"id": "ImageAsset",
"properties": {
"fileSize": {
-"description": "File size of the image asset in bytes.",
+"description": "Output only. File size of the image asset in bytes.",
"format": "int64",
+"readOnly": true,
"type": "string"
},
"fullSize": {
"$ref": "Dimensions",
-"description": "Metadata for this image at its original size."
+"description": "Output only. Metadata for this image at its original size.",
+"readOnly": true
},
"mimeType": {
-"description": "MIME type of the image asset.",
+"description": "Output only. MIME type of the image asset.",
+"readOnly": true,
"type": "string"
}
},
@@ -24711,7 +24726,8 @@
"id": "YoutubeVideoDetails",
"properties": {
"id": {
-"description": "The YouTube video ID which can be searched on YouTube webpage.",
+"description": "Output only. The YouTube video ID which can be searched on YouTube webpage.",
+"readOnly": true,
"type": "string"
},
"unavailableReason": {
@@ -24727,6 +24743,11 @@
"The video is deleted."
],
"type": "string"
+},
+"videoAssetId": {
+"description": "Required. The YouTube video asset id. This is ad_asset.ad_asset_id.",
+"format": "int64",
+"type": "string"
}
},
"type": "object"
diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json
index a557bd3..ad31553 100644
--- a/googleapiclient/discovery_cache/documents/eventarc.v1.json
+++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json
@@ -18,6 +18,241 @@
"endpoints": [
{
"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.africa-south1.rep.googleapis.com/",
+"location": "africa-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-east1.rep.googleapis.com/",
+"location": "asia-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-east2.rep.googleapis.com/",
+"location": "asia-east2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-northeast1.rep.googleapis.com/",
+"location": "asia-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-northeast2.rep.googleapis.com/",
+"location": "asia-northeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-northeast3.rep.googleapis.com/",
+"location": "asia-northeast3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-south1.rep.googleapis.com/",
+"location": "asia-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-south2.rep.googleapis.com/",
+"location": "asia-south2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-southeast1.rep.googleapis.com/",
+"location": "asia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-southeast2.rep.googleapis.com/",
+"location": "asia-southeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.asia-southeast3.rep.googleapis.com/",
+"location": "asia-southeast3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.australia-southeast1.rep.googleapis.com/",
+"location": "australia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.australia-southeast2.rep.googleapis.com/",
+"location": "australia-southeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-central2.rep.googleapis.com/",
+"location": "europe-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-north1.rep.googleapis.com/",
+"location": "europe-north1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-north2.rep.googleapis.com/",
+"location": "europe-north2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-southwest1.rep.googleapis.com/",
+"location": "europe-southwest1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west1.rep.googleapis.com/",
+"location": "europe-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west10.rep.googleapis.com/",
+"location": "europe-west10"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west12.rep.googleapis.com/",
+"location": "europe-west12"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west15.rep.googleapis.com/",
+"location": "europe-west15"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west2.rep.googleapis.com/",
+"location": "europe-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west3.rep.googleapis.com/",
+"location": "europe-west3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west4.rep.googleapis.com/",
+"location": "europe-west4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west6.rep.googleapis.com/",
+"location": "europe-west6"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west8.rep.googleapis.com/",
+"location": "europe-west8"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.europe-west9.rep.googleapis.com/",
+"location": "europe-west9"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.me-central1.rep.googleapis.com/",
+"location": "me-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.me-central2.rep.googleapis.com/",
+"location": "me-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.me-west1.rep.googleapis.com/",
+"location": "me-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.northamerica-northeast1.rep.googleapis.com/",
+"location": "northamerica-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.northamerica-northeast2.rep.googleapis.com/",
+"location": "northamerica-northeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.northamerica-south1.rep.googleapis.com/",
+"location": "northamerica-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.southamerica-east1.rep.googleapis.com/",
+"location": "southamerica-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.southamerica-west1.rep.googleapis.com/",
+"location": "southamerica-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-central1.rep.googleapis.com/",
+"location": "us-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-central2.rep.googleapis.com/",
+"location": "us-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-east1.rep.googleapis.com/",
+"location": "us-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-east4.rep.googleapis.com/",
+"location": "us-east4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-east5.rep.googleapis.com/",
+"location": "us-east5"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-east7.rep.googleapis.com/",
+"location": "us-east7"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-south1.rep.googleapis.com/",
+"location": "us-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-west1.rep.googleapis.com/",
+"location": "us-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-west2.rep.googleapis.com/",
+"location": "us-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-west3.rep.googleapis.com/",
+"location": "us-west3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-west4.rep.googleapis.com/",
+"location": "us-west4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://eventarc.us-west8.rep.googleapis.com/",
+"location": "us-west8"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://eventarc.us.rep.googleapis.com/",
"location": "us"
},
@@ -2392,7 +2627,7 @@
}
}
},
-"revision": "20260130",
+"revision": "20260206",
"rootUrl": "https://eventarc.googleapis.com/",
"schemas": {
"AuditConfig": {
diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json
index b8deba5..b77c4ca 100644
--- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json
+++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json
@@ -1661,7 +1661,7 @@
}
}
},
-"revision": "20250901",
+"revision": "20260207",
"rootUrl": "https://firebaseappcheck.googleapis.com/",
"schemas": {
"GoogleFirebaseAppcheckV1AppAttestConfig": {
@@ -2361,16 +2361,16 @@
"id": "GoogleFirebaseAppcheckV1ResourcePolicy",
"properties": {
"enforcementMode": {
-"description": "Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.",
+"description": "Required. The App Check enforcement mode for this resource. This will override the App Check overall EnforcementMode setting on the service.",
"enum": [
"OFF",
"UNENFORCED",
"ENFORCED"
],
"enumDescriptions": [
-"Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default.",
-"Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
-"Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
+"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.",
+"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
+"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
],
"type": "string"
},
@@ -2424,9 +2424,9 @@
"ENFORCED"
],
"enumDescriptions": [
-"Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default.",
-"Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
-"Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
+"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.",
+"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
+"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json
index 3f8a2de..b8c5c28 100644
--- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json
@@ -1823,7 +1823,7 @@
}
}
},
-"revision": "20260110",
+"revision": "20260207",
"rootUrl": "https://firebaseappcheck.googleapis.com/",
"schemas": {
"GoogleFirebaseAppcheckV1betaAppAttestConfig": {
@@ -2619,9 +2619,9 @@
"ENFORCED"
],
"enumDescriptions": [
-"Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default.",
-"Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
-"Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
+"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.",
+"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
+"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
],
"type": "string"
},
@@ -2675,9 +2675,9 @@
"ENFORCED"
],
"enumDescriptions": [
-"Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default.",
-"Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
-"Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
+"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.",
+"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
+"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
],
"type": "string"
},
diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v2.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v2.json
new file mode 100644
index 0000000..0de8193
--- /dev/null
+++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v2.json
@@ -0,0 +1,834 @@
+{
+"auth": {
+"oauth2": {
+"scopes": {
+"https://www.googleapis.com/auth/postmaster": {
+"description": "Get email traffic metrics, manage domains, and manage domain users for the domains you have registered with Postmaster Tools"
+},
+"https://www.googleapis.com/auth/postmaster.domain": {
+"description": "View and manage the domains you have registered with Postmaster Tools"
+},
+"https://www.googleapis.com/auth/postmaster.traffic.readonly": {
+"description": "Get email traffic metrics for the domains you have registered with Postmaster Tools"
+}
+}
+}
+},
+"basePath": "",
+"baseUrl": "https://gmailpostmastertools.googleapis.com/",
+"batchPath": "batch",
+"canonicalName": "Postmaster Tools",
+"description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.",
+"discoveryVersion": "v1",
+"documentationLink": "https://developers.google.com/workspace/gmail/postmaster",
+"fullyEncodeReservedExpansion": true,
+"icons": {
+"x16": "http://www.google.com/images/icons/product/search-16.gif",
+"x32": "http://www.google.com/images/icons/product/search-32.gif"
+},
+"id": "gmailpostmastertools:v2",
+"kind": "discovery#restDescription",
+"mtlsRootUrl": "https://gmailpostmastertools.mtls.googleapis.com/",
+"name": "gmailpostmastertools",
+"ownerDomain": "google.com",
+"ownerName": "Google",
+"parameters": {
+"$.xgafv": {
+"description": "V1 error format.",
+"enum": [
+"1",
+"2"
+],
+"enumDescriptions": [
+"v1 error format",
+"v2 error format"
+],
+"location": "query",
+"type": "string"
+},
+"access_token": {
+"description": "OAuth access token.",
+"location": "query",
+"type": "string"
+},
+"alt": {
+"default": "json",
+"description": "Data format for response.",
+"enum": [
+"json",
+"media",
+"proto"
+],
+"enumDescriptions": [
+"Responses with Content-Type of application/json",
+"Media download with context-dependent Content-Type",
+"Responses with Content-Type of application/x-protobuf"
+],
+"location": "query",
+"type": "string"
+},
+"callback": {
+"description": "JSONP",
+"location": "query",
+"type": "string"
+},
+"fields": {
+"description": "Selector specifying which fields to include in a partial response.",
+"location": "query",
+"type": "string"
+},
+"key": {
+"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+"location": "query",
+"type": "string"
+},
+"oauth_token": {
+"description": "OAuth 2.0 token for the current user.",
+"location": "query",
+"type": "string"
+},
+"prettyPrint": {
+"default": "true",
+"description": "Returns response with indentations and line breaks.",
+"location": "query",
+"type": "boolean"
+},
+"quotaUser": {
+"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+"location": "query",
+"type": "string"
+},
+"uploadType": {
+"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+"location": "query",
+"type": "string"
+},
+"upload_protocol": {
+"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+"location": "query",
+"type": "string"
+}
+},
+"protocol": "rest",
+"resources": {
+"domainStats": {
+"methods": {
+"batchQuery": {
+"description": "Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of the requested domains.",
+"flatPath": "v2/domainStats:batchQuery",
+"httpMethod": "POST",
+"id": "gmailpostmastertools.domainStats.batchQuery",
+"parameterOrder": [],
+"parameters": {},
+"path": "v2/domainStats:batchQuery",
+"request": {
+"$ref": "BatchQueryDomainStatsRequest"
+},
+"response": {
+"$ref": "BatchQueryDomainStatsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/postmaster",
+"https://www.googleapis.com/auth/postmaster.traffic.readonly"
+]
+}
+}
+},
+"domains": {
+"methods": {
+"get": {
+"description": "Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.",
+"flatPath": "v2/domains/{domainsId}",
+"httpMethod": "GET",
+"id": "gmailpostmastertools.domains.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).",
+"location": "path",
+"pattern": "^domains/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+name}",
+"response": {
+"$ref": "Domain"
+},
+"scopes": [
+"https://www.googleapis.com/auth/postmaster",
+"https://www.googleapis.com/auth/postmaster.domain"
+]
+},
+"getComplianceStatus": {
+"description": "Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.",
+"flatPath": "v2/domains/{domainsId}/complianceStatus",
+"httpMethod": "GET",
+"id": "gmailpostmastertools.domains.getComplianceStatus",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the domain's compliance status to retrieve. Format: `domains/{domain_id}/complianceStatus`.",
+"location": "path",
+"pattern": "^domains/[^/]+/complianceStatus$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+name}",
+"response": {
+"$ref": "DomainComplianceStatus"
+},
+"scopes": [
+"https://www.googleapis.com/auth/postmaster",
+"https://www.googleapis.com/auth/postmaster.traffic.readonly"
+]
+},
+"list": {
+"description": "Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.",
+"flatPath": "v2/domains",
+"httpMethod": "GET",
+"id": "gmailpostmastertools.domains.list",
+"parameterOrder": [],
+"parameters": {
+"pageSize": {
+"description": "Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The next_page_token value returned from a previous List request, if any.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v2/domains",
+"response": {
+"$ref": "ListDomainsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/postmaster",
+"https://www.googleapis.com/auth/postmaster.domain"
+]
+}
+},
+"resources": {
+"domainStats": {
+"methods": {
+"query": {
+"description": "Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain.",
+"flatPath": "v2/domains/{domainsId}/domainStats:query",
+"httpMethod": "POST",
+"id": "gmailpostmastertools.domains.domainStats.query",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource name where the stats are queried. Format: domains/{domain}",
+"location": "path",
+"pattern": "^domains/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+parent}/domainStats:query",
+"request": {
+"$ref": "QueryDomainStatsRequest"
+},
+"response": {
+"$ref": "QueryDomainStatsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/postmaster",
+"https://www.googleapis.com/auth/postmaster.traffic.readonly"
+]
+}
+}
+}
+}
+}
+},
+"revision": "20260209",
+"rootUrl": "https://gmailpostmastertools.googleapis.com/",
+"schemas": {
+"BaseMetric": {
+"description": "Specifies the base metric to query, which can be a predefined standard metric or a user-defined custom metric (if supported in the future).",
+"id": "BaseMetric",
+"properties": {
+"standardMetric": {
+"description": "A predefined standard metric.",
+"enum": [
+"STANDARD_METRIC_UNSPECIFIED",
+"FEEDBACK_LOOP_ID",
+"FEEDBACK_LOOP_SPAM_RATE",
+"SPAM_RATE",
+"AUTH_SUCCESS_RATE",
+"TLS_ENCRYPTION_MESSAGE_COUNT",
+"TLS_ENCRYPTION_RATE",
+"DELIVERY_ERROR_COUNT",
+"DELIVERY_ERROR_RATE"
+],
+"enumDescriptions": [
+"Unspecified standard metric. This value should not be used directly.",
+"Predefined metric for Feedback Loop (FBL) id.",
+"Predefined metric for Feedback Loop (FBL) spam rate. Filter must be of type feedback_loop_id = \"\" where is one valid feedback loop ids.",
+"Predefined metric for spam rate.",
+"The success rate of authentication mechanisms (DKIM, SPF, DMARC). Filter must be of type auth_type = \"\" where is one of: [spf, dkim, dmarc]",
+"The rate of messages that were TLS encrypted in transit Filter must be of type traffic_direction = \"\" where is one of: [inbound, outbound]",
+"The rate of messages that were TLS encrypted in transit Filter must be of type traffic_direction = \"\" where is one of: [inbound, outbound]",
+"The total count of delivery errors encountered (temporary or permanent rejects). The `filter` field supports a limited syntax. Supported formats are: * Empty: No filter is applied. * `error_type` = \"\" * `error_type` = \"\" AND `error_reason` = \"\" If an empty filter is provided, the metric will be aggregated across all error types and reasons. If only `error_type` is specified, the metric will be aggregated across all reasons for that type. Supported values: * reject * temp_fail Supported values depend on the : * For 'reject': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other] * For 'temp_fail': [anomalous_traffic_pattern, other]",
+"Delivery error rate for the specified delivery error type. The `filter` field supports a limited syntax. Supported formats are: * Empty: No filter is applied. * `error_type` = \"\" * `error_type` = \"\" AND `error_reason` = \"\" If an empty filter is provided, the metric will be aggregated across all error types and reasons. If only `error_type` is specified, the metric will be aggregated across all reasons for that type. Supported values: * reject * temp_fail Supported values depend on the : * For 'reject': [bad_attachment, bad_or_missing_ptr_record, ip_in_rbls, low_domain_reputation, low_ip_reputation, spammy_content, stamp_policy_error, other] * For 'temp_fail': [anomalous_traffic_pattern, other]"
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"BatchQueryDomainStatsRequest": {
+"description": "Request message for BatchQueryDomainStats.",
+"id": "BatchQueryDomainStatsRequest",
+"properties": {
+"requests": {
+"description": "Required. A list of individual query requests. Each request can be for a different domain. A maximum of 100 requests can be included in a single batch.",
+"items": {
+"$ref": "QueryDomainStatsRequest"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"BatchQueryDomainStatsResponse": {
+"description": "Response message for BatchQueryDomainStats.",
+"id": "BatchQueryDomainStatsResponse",
+"properties": {
+"results": {
+"description": "A list of responses, one for each query in the BatchQueryDomainStatsRequest. The order of responses will correspond to the order of requests.",
+"items": {
+"$ref": "BatchQueryDomainStatsResult"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"BatchQueryDomainStatsResult": {
+"description": "Represents the result of a single QueryDomainStatsRequest within a batch.",
+"id": "BatchQueryDomainStatsResult",
+"properties": {
+"error": {
+"$ref": "Status",
+"description": "The error status if the individual query failed."
+},
+"response": {
+"$ref": "QueryDomainStatsResponse",
+"description": "The successful response for the individual query."
+}
+},
+"type": "object"
+},
+"ComplianceRowData": {
+"description": "Data for a single row of the compliance status table.",
+"id": "ComplianceRowData",
+"properties": {
+"requirement": {
+"description": "The compliance requirement.",
+"enum": [
+"COMPLIANCE_REQUIREMENT_UNSPECIFIED",
+"SPF",
+"DKIM",
+"SPF_AND_DKIM",
+"DMARC_POLICY",
+"DMARC_ALIGNMENT",
+"MESSAGE_FORMATTING",
+"DNS_RECORDS",
+"ENCRYPTION",
+"USER_REPORTED_SPAM_RATE",
+"ONE_CLICK_UNSUBSCRIBE",
+"HONOR_UNSUBSCRIBE"
+],
+"enumDescriptions": [
+"Unspecified.",
+"Whether the sender has properly configured SPF.",
+"Whether the sender has properly configured DKIM.",
+"Whether the sender has properly configured both SPF and DKIM.",
+"Whether the sender has configured DMARC policy.",
+"Whether the From: header is aligned with DKIM or SPF",
+"Whether messages are correctly formatted according to RFC 5322.",
+"Whether the domain has forward and reverse DNS records.",
+"Whether messages has TLS encryption.",
+"Whether the sender is below a threshold for user-reported spam rate.",
+"Whether the sender sufficiently supports one-click unsubscribe. Note that the user-facing requirement is \"one-click unsubscribe\", but we require satisfaction of multiple \"unsubscribe support\" rules.",
+"Whether the sender honors user-initiated unsubscribe requests."
+],
+"type": "string"
+},
+"status": {
+"$ref": "ComplianceStatus",
+"description": "The compliance status for the requirement."
+}
+},
+"type": "object"
+},
+"ComplianceStatus": {
+"description": "The status of a sender compliance requirement.",
+"id": "ComplianceStatus",
+"properties": {
+"status": {
+"description": "Output only. The compliance status.",
+"enum": [
+"STATE_UNSPECIFIED",
+"COMPLIANT",
+"NEEDS_WORK"
+],
+"enumDescriptions": [
+"Unspecified.",
+"The compliance requirement is met, and the sender is deemed compliant.",
+"The compliance requirement is unmet, and the sender needs to do work to achieve compliance."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"Date": {
+"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
+"id": "Date",
+"properties": {
+"day": {
+"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
+"format": "int32",
+"type": "integer"
+},
+"month": {
+"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
+"format": "int32",
+"type": "integer"
+},
+"year": {
+"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"DateList": {
+"description": "A set of specific dates.",
+"id": "DateList",
+"properties": {
+"dates": {
+"description": "Required. The list of specific dates for which to retrieve data.",
+"items": {
+"$ref": "Date"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"DateRange": {
+"description": "A single date range defined by a start and end date.",
+"id": "DateRange",
+"properties": {
+"end": {
+"$ref": "Date",
+"description": "Required. The inclusive end date of the date range."
+},
+"start": {
+"$ref": "Date",
+"description": "Required. The inclusive start date of the date range."
+}
+},
+"type": "object"
+},
+"DateRanges": {
+"description": "A set of date ranges.",
+"id": "DateRanges",
+"properties": {
+"dateRanges": {
+"description": "Required. The list of date ranges for which to retrieve data.",
+"items": {
+"$ref": "DateRange"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"Domain": {
+"description": "Information about a domain registered by the user.",
+"id": "Domain",
+"properties": {
+"createTime": {
+"description": "Output only. Immutable. The timestamp at which the domain was added to the user's account.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"lastVerifyTime": {
+"description": "The timestamp at which the domain was last verified by the user.",
+"format": "google-datetime",
+"type": "string"
+},
+"name": {
+"description": "Identifier. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).",
+"type": "string"
+},
+"permission": {
+"description": "Output only. User's permission of this domain.",
+"enum": [
+"PERMISSION_UNSPECIFIED",
+"READER",
+"OWNER",
+"NONE"
+],
+"enumDescriptions": [
+"Unspecified permission.",
+"User has read access to the domain.",
+"User has owner access to the domain.",
+"User has no access to the domain."
+],
+"readOnly": true,
+"type": "string"
+},
+"verificationState": {
+"description": "Output only. Information about a user's verification history and properties for the domain.",
+"enum": [
+"VERIFICATION_STATE_UNSPECIFIED",
+"UNVERIFIED",
+"VERIFIED"
+],
+"enumDescriptions": [
+"Unspecified.",
+"The domain is unverified.",
+"The domain is verified."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"DomainComplianceData": {
+"description": "Compliance data for a given domain.",
+"id": "DomainComplianceData",
+"properties": {
+"domainId": {
+"description": "Domain that this data is for.",
+"type": "string"
+},
+"honorUnsubscribeVerdict": {
+"$ref": "HonorUnsubscribeVerdict",
+"description": "Unsubscribe honoring compliance verdict."
+},
+"oneClickUnsubscribeVerdict": {
+"$ref": "OneClickUnsubscribeVerdict",
+"description": "One-click unsubscribe compliance verdict."
+},
+"rowData": {
+"description": "Data for each of the rows of the table. Each message contains all the data that backs a single row.",
+"items": {
+"$ref": "ComplianceRowData"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"DomainComplianceStatus": {
+"description": "Compliance status for a domain.",
+"id": "DomainComplianceStatus",
+"properties": {
+"complianceData": {
+"$ref": "DomainComplianceData",
+"description": "Compliance data for the registrable domain part of the domain in `name`. For example, if `name` is `domains/example.com/complianceStatus`, this field contains compliance data for `example.com`."
+},
+"name": {
+"description": "Identifier. The resource name of the domain's compliance status. Format: `domains/{domain_id}/complianceStatus`.",
+"type": "string"
+},
+"subdomainComplianceData": {
+"$ref": "DomainComplianceData",
+"description": "Compliance data calculated specifically for the subdomain in `name`. This field is only populated if the domain in `name` is a subdomain that differs from its registrable domain (e.g., `sub.example.com`), and if compliance data is available for that specific subdomain."
+}
+},
+"type": "object"
+},
+"DomainStat": {
+"description": "Email statistics for a domain for a specified time period or date.",
+"id": "DomainStat",
+"properties": {
+"date": {
+"$ref": "Date",
+"description": "Optional. The specific date for these stats, if granularity is DAILY. This field is populated if the QueryDomainStatsRequest specified a DAILY aggregation granularity."
+},
+"metric": {
+"description": "The user-defined name from MetricDefinition.name in the request, used to correlate this result with the requested metric.",
+"type": "string"
+},
+"name": {
+"description": "Output only. The resource name of the DomainStat resource. Format: domains/{domain}/domainStats/{domain_stat} The `{domain_stat}` segment is an opaque, server-generated ID. We recommend using the `metric` field to identify queried metrics instead of parsing the name.",
+"readOnly": true,
+"type": "string"
+},
+"value": {
+"$ref": "StatisticValue",
+"description": "The value of the corresponding metric."
+}
+},
+"type": "object"
+},
+"HonorUnsubscribeVerdict": {
+"description": "Compliance verdict for whether a sender meets the unsubscribe honoring compliance requirement.",
+"id": "HonorUnsubscribeVerdict",
+"properties": {
+"reason": {
+"description": "The specific reason for the compliance verdict. Must be empty if the status is compliant.",
+"enum": [
+"REASON_UNSPECIFIED",
+"NOT_HONORING",
+"NOT_HONORING_TOO_FEW_CAMPAIGNS",
+"NOT_HONORING_TOO_MANY_CAMPAIGNS"
+],
+"enumDescriptions": [
+"Unspecified.",
+"The sender does not honor unsubscribe requests.",
+"The sender does not honor unsubscribe requests and consider to increase the number of relevant campaigns.",
+"The sender does not honor unsubscribe requests and consider to reduce the number of relevant campaigns."
+],
+"type": "string"
+},
+"status": {
+"$ref": "ComplianceStatus",
+"description": "The compliance status."
+}
+},
+"type": "object"
+},
+"ListDomainsResponse": {
+"description": "Response message for ListDomains.",
+"id": "ListDomainsResponse",
+"properties": {
+"domains": {
+"description": "The domains that have been registered by the user.",
+"items": {
+"$ref": "Domain"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"MetricDefinition": {
+"description": "Defines a specific metric to query, including a user-defined name, the base metric type, and optional filters.",
+"id": "MetricDefinition",
+"properties": {
+"baseMetric": {
+"$ref": "BaseMetric",
+"description": "Required. The underlying metric to query."
+},
+"filter": {
+"description": "Optional. Optional filters to apply to the metric.",
+"type": "string"
+},
+"name": {
+"description": "Required. The user-defined name for this metric. This name will be used as the key for this metric's value in the response.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"OneClickUnsubscribeVerdict": {
+"description": "Compliance verdict for whether a sender meets the one-click unsubscribe compliance requirement.",
+"id": "OneClickUnsubscribeVerdict",
+"properties": {
+"reason": {
+"description": "The specific reason for the compliance verdict. Must be empty if the status is compliant.",
+"enum": [
+"REASON_UNSPECIFIED",
+"NO_UNSUB_GENERAL",
+"NO_UNSUB_SPAM_REPORTS",
+"NO_UNSUB_PROMO_SPAM_REPORTS"
+],
+"enumDescriptions": [
+"Unspecified.",
+"Sender does not support one-click unsubscribe for the majority of their messages.",
+"Sender does not support one-click unsubscribe for most messages that are manually reported as spam.",
+"Sender does not support one-click unsubscribe for most promotional messages that are manually reported as spam. This classification of messages is a subset of those encompassed by `NO_UNSUB_SPAM_REPORTS`."
+],
+"type": "string"
+},
+"status": {
+"$ref": "ComplianceStatus",
+"description": "The compliance status."
+}
+},
+"type": "object"
+},
+"QueryDomainStatsRequest": {
+"description": "Request message for QueryDomainStats.",
+"id": "QueryDomainStatsRequest",
+"properties": {
+"aggregationGranularity": {
+"description": "Optional. The granularity at which to aggregate the statistics. If unspecified, defaults to DAILY.",
+"enum": [
+"AGGREGATION_GRANULARITY_UNSPECIFIED",
+"DAILY",
+"OVERALL"
+],
+"enumDescriptions": [
+"Unspecified granularity. Defaults to DAILY.",
+"Statistics are aggregated on a daily basis. Each DomainStats entry in the response will correspond to a single day.",
+"Statistics are aggregated over the entire requested time period. Each DomainStats entry in the response will represent the total for the period."
+],
+"type": "string"
+},
+"metricDefinitions": {
+"description": "Required. The specific metrics to query. You can define a custom name for each metric, which will be used in the response.",
+"items": {
+"$ref": "MetricDefinition"
+},
+"type": "array"
+},
+"pageSize": {
+"description": "Optional. The maximum number of DomainStats resources to return in the response. The server may return fewer than this value. If unspecified, a default value of 10 will be used. The maximum value is 200.",
+"format": "int32",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The next_page_token value returned from a previous List request, if any. If the aggregation granularity is DAILY, the page token will be the encoded date + \"/\" + metric name. If the aggregation granularity is OVERALL, the page token will be the encoded metric name.",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent resource name where the stats are queried. Format: domains/{domain}",
+"type": "string"
+},
+"timeQuery": {
+"$ref": "TimeQuery",
+"description": "Required. The time range or specific dates for which to retrieve the metrics."
+}
+},
+"type": "object"
+},
+"QueryDomainStatsResponse": {
+"description": "Response message for QueryDomainStats.",
+"id": "QueryDomainStatsResponse",
+"properties": {
+"domainStats": {
+"description": "The list of domain statistics. Each DomainStat object contains the value for a metric requested in the QueryDomainStatsRequest.",
+"items": {
+"$ref": "DomainStat"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"StatisticValue": {
+"description": "The actual value of a statistic.",
+"id": "StatisticValue",
+"properties": {
+"doubleValue": {
+"description": "Double value.",
+"format": "double",
+"type": "number"
+},
+"floatValue": {
+"description": "Float value.",
+"format": "float",
+"type": "number"
+},
+"intValue": {
+"description": "Integer value.",
+"format": "int64",
+"type": "string"
+},
+"stringList": {
+"$ref": "StringList",
+"description": "List of string values."
+},
+"stringValue": {
+"description": "String value.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Status": {
+"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
+"id": "Status",
+"properties": {
+"code": {
+"description": "The status code, which should be an enum value of google.rpc.Code.",
+"format": "int32",
+"type": "integer"
+},
+"details": {
+"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+"items": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"StringList": {
+"description": "Represents a list of strings.",
+"id": "StringList",
+"properties": {
+"values": {
+"description": "The string values.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"TimeQuery": {
+"description": "The date ranges or specific dates for which you want to retrieve data.",
+"id": "TimeQuery",
+"properties": {
+"dateList": {
+"$ref": "DateList",
+"description": "A list of specific dates."
+},
+"dateRanges": {
+"$ref": "DateRanges",
+"description": "A list of date ranges."
+}
+},
+"type": "object"
+}
+},
+"servicePath": "",
+"title": "Gmail Postmaster Tools API",
+"version": "v2",
+"version_module": true
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json
index 40860cd..b586394 100644
--- a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json
+++ b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json
@@ -12,7 +12,7 @@
"baseUrl": "https://hypercomputecluster.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Hypercompute Cluster",
-"description": "",
+"description": "The Cluster Director API allows you to deploy, manage, and monitor clusters that run AI, ML, or HPC workloads.",
"discoveryVersion": "v1",
"documentationLink": "https://docs.cloud.google.com/cluster-director/docs",
"fullyEncodeReservedExpansion": true,
@@ -135,7 +135,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "hypercomputecluster.projects.locations.list",
@@ -498,7 +498,7 @@
}
}
},
-"revision": "20260121",
+"revision": "20260204",
"rootUrl": "https://hypercomputecluster.googleapis.com/",
"schemas": {
"BootDisk": {
@@ -1321,16 +1321,16 @@
"type": "string"
},
"terminationAction": {
-"description": "Optional. Specifies the termination action of the instance",
+"description": "Optional. Termination action for the instance. If not specified, Compute Engine sets the termination action to DELETE.",
"enum": [
"TERMINATION_ACTION_UNSPECIFIED",
"STOP",
"DELETE"
],
"enumDescriptions": [
-"Unspecified termination action",
-"Stop the instance",
-"Delete the instance"
+"Not set.",
+"Compute Engine stops the Spot VM on preemption.",
+"Compute Engine deletes the Spot VM on preemption."
],
"type": "string"
},
@@ -1421,7 +1421,7 @@
"type": "object"
},
"OperationProgress": {
-"description": "Message describing the progress of a cluster mutation long-running operation. operation.",
+"description": "Message describing the progress of a cluster mutation long-running operation.",
"id": "OperationProgress",
"properties": {
"steps": {
@@ -1648,7 +1648,7 @@
"id": "SlurmNodeSet",
"properties": {
"computeId": {
-"description": "Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's [compute_resources](Cluster.compute_resources).",
+"description": "Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources.",
"type": "string"
},
"computeInstance": {
@@ -1699,14 +1699,14 @@
"description": "Required. Configuration for login nodes, which allow users to access the cluster over SSH."
},
"nodeSets": {
-"description": "Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.",
+"description": "Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes.",
"items": {
"$ref": "SlurmNodeSet"
},
"type": "array"
},
"partitions": {
-"description": "Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.",
+"description": "Optional. Configuration for the Slurm partitions in your cluster. Each partition can contain one or more nodesets, and you can submit separate jobs on each partition. If you don't specify at least one partition in your cluster, you can't submit jobs to the cluster.",
"items": {
"$ref": "SlurmPartition"
},
@@ -1772,7 +1772,7 @@
"id": "StorageConfig",
"properties": {
"id": {
-"description": "Required. ID of the storage resource to mount, which must match a key in the cluster's [storage_resources](Cluster.storage_resources).",
+"description": "Required. ID of the storage resource to mount, which must match a key in the cluster's storage_resources.",
"type": "string"
},
"localMount": {
diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json
index 0be9942..e898677 100644
--- a/googleapiclient/discovery_cache/documents/iam.v1.json
+++ b/googleapiclient/discovery_cache/documents/iam.v1.json
@@ -4160,7 +4160,7 @@
}
}
},
-"revision": "20260123",
+"revision": "20260206",
"rootUrl": "https://iam.googleapis.com/",
"schemas": {
"AccessRestrictions": {
@@ -4546,14 +4546,12 @@
"enum": [
"ATTRIBUTES_TYPE_UNSPECIFIED",
"AZURE_AD_GROUPS_MAIL",
-"AZURE_AD_GROUPS_ID",
-"AZURE_AD_GROUPS_DISPLAY_NAME"
+"AZURE_AD_GROUPS_ID"
],
"enumDescriptions": [
"No AttributesType specified.",
"Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group mail addresses of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`",
-"Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `id` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group IDs of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`",
-"Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `displayName` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The display names of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`"
+"Used to get the user's group claims from the Microsoft Entra ID identity provider using the configuration provided in ExtraAttributesOAuth2Client. The `id` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The group IDs of the user's groups that are returned from Microsoft Entra ID can be mapped by using the following attributes: * OIDC: `assertion.groups` * SAML: `assertion.attributes.groups`"
],
"type": "string"
},
@@ -6340,7 +6338,7 @@
},
"extraAttributesOauth2Client": {
"$ref": "GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client",
-"description": "Optional. The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently, this configuration is only supported with OIDC protocol."
+"description": "Optional. Defines the configuration for the OAuth 2.0 client that is used to get the additional user attributes in a separate backchannel call to the identity provider. This should be used when users can't get the required claims in authentication credentials. Currently, the OAuth 2.0 protocol is the only supported authorization method for this backchannel call."
},
"name": {
"description": "Identifier. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`",
diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json
index bcb1536..d70a3dc 100644
--- a/googleapiclient/discovery_cache/documents/iap.v1.json
+++ b/googleapiclient/discovery_cache/documents/iap.v1.json
@@ -682,7 +682,7 @@
}
}
},
-"revision": "20251013",
+"revision": "20260209",
"rootUrl": "https://iap.googleapis.com/",
"schemas": {
"AccessDeniedPageSettings": {
@@ -1098,6 +1098,19 @@
"description": "Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.",
"id": "OAuthSettings",
"properties": {
+"clientId": {
+"description": "Optional. OAuth 2.0 client ID used in the OAuth flow to generate an access token. If this field is set, you can skip obtaining the OAuth credentials in this step: https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console. However, this could allow for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.",
+"type": "string"
+},
+"clientSecret": {
+"description": "Optional. Input only. OAuth secret paired with client ID",
+"type": "string"
+},
+"clientSecretSha256": {
+"description": "Output only. OAuth secret sha256 paired with client ID",
+"readOnly": true,
+"type": "string"
+},
"loginHint": {
"description": "Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json
index e80108e..36ce7a3 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json
@@ -2410,7 +2410,7 @@
}
}
},
-"revision": "20260203",
+"revision": "20260206",
"rootUrl": "https://merchantapi.googleapis.com/",
"schemas": {
"About": {
@@ -3230,7 +3230,7 @@
"description": "Required. The account to be created."
},
"service": {
-"description": "Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `product_management` services may be provided.",
+"description": "Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `products_management` services may be provided.",
"items": {
"$ref": "AddAccountService"
},
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
index b351f69..086776d 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
@@ -2360,7 +2360,7 @@
}
}
},
-"revision": "20260203",
+"revision": "20260206",
"rootUrl": "https://merchantapi.googleapis.com/",
"schemas": {
"About": {
@@ -3110,7 +3110,7 @@
"description": "Required. The account to be created."
},
"service": {
-"description": "Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `product_management` services may be provided.",
+"description": "Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation` and `accounts.createAndConfigure` method can be used to create a sub-account under an existing advanced account through this method. Additional `account_management` or `products_management` services may be provided.",
"items": {
"$ref": "AddAccountService"
},
diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json
index 026cea9..837b796 100644
--- a/googleapiclient/discovery_cache/documents/metastore.v1.json
+++ b/googleapiclient/discovery_cache/documents/metastore.v1.json
@@ -135,7 +135,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "metastore.projects.locations.list",
@@ -1695,7 +1695,7 @@
}
}
},
-"revision": "20260122",
+"revision": "20260203",
"rootUrl": "https://metastore.googleapis.com/",
"schemas": {
"AlterMetadataResourceLocationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json
index 268a8fb..1e386f8 100644
--- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json
@@ -135,7 +135,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1alpha/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "metastore.projects.locations.list",
@@ -1807,7 +1807,7 @@
}
}
},
-"revision": "20260122",
+"revision": "20260203",
"rootUrl": "https://metastore.googleapis.com/",
"schemas": {
"AlterMetadataResourceLocationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json
index 76c2f5e..aa6beb9 100644
--- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json
@@ -135,7 +135,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: List all public locations: Use the path GET /v1/locations. List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1beta/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "metastore.projects.locations.list",
@@ -1807,7 +1807,7 @@
}
}
},
-"revision": "20260122",
+"revision": "20260203",
"rootUrl": "https://metastore.googleapis.com/",
"schemas": {
"AlterMetadataResourceLocationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json
index 9a65a83..8cba0b1 100644
--- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json
+++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json
@@ -5419,7 +5419,7 @@
}
}
},
-"revision": "20260131",
+"revision": "20260204",
"rootUrl": "https://networksecurity.googleapis.com/",
"schemas": {
"AddAddressGroupItemsRequest": {
@@ -8536,13 +8536,15 @@
"PROFILE_TYPE_UNSPECIFIED",
"THREAT_PREVENTION",
"CUSTOM_MIRRORING",
-"CUSTOM_INTERCEPT"
+"CUSTOM_INTERCEPT",
+"URL_FILTERING"
],
"enumDescriptions": [
"Profile type not specified.",
"Profile type for threat prevention.",
"Profile type for packet mirroring v2",
-"Profile type for TPPI."
+"Profile type for TPPI.",
+"Profile type for URL filtering."
],
"type": "string"
},
@@ -8551,6 +8553,10 @@
"format": "google-datetime",
"readOnly": true,
"type": "string"
+},
+"urlFilteringProfile": {
+"$ref": "UrlFilteringProfile",
+"description": "The URL filtering configuration for the SecurityProfile."
}
},
"type": "object"
@@ -8608,6 +8614,10 @@
"format": "google-datetime",
"readOnly": true,
"type": "string"
+},
+"urlFilteringProfile": {
+"description": "Optional. Reference to a SecurityProfile with the UrlFiltering configuration.",
+"type": "string"
}
},
"type": "object"
@@ -8911,6 +8921,53 @@
},
"type": "object"
},
+"UrlFilter": {
+"description": "A URL filter defines an action to take for some URL match.",
+"id": "UrlFilter",
+"properties": {
+"filteringAction": {
+"description": "Required. The action taken when this filter is applied.",
+"enum": [
+"URL_FILTERING_ACTION_UNSPECIFIED",
+"ALLOW",
+"DENY"
+],
+"enumDescriptions": [
+"Filtering action not specified.",
+"The connection matching this filter will be allowed to transmit.",
+"The connection matching this filter will be dropped."
+],
+"type": "string"
+},
+"priority": {
+"description": "Required. The priority of this filter within the URL Filtering Profile. Lower integers indicate higher priorities. The priority of a filter must be unique within a URL Filtering Profile.",
+"format": "int32",
+"type": "integer"
+},
+"urls": {
+"description": "Required. The list of strings that a URL must match with for this filter to be applied.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"UrlFilteringProfile": {
+"description": "UrlFilteringProfile defines filters based on URL.",
+"id": "UrlFilteringProfile",
+"properties": {
+"urlFilters": {
+"description": "Optional. The list of filtering configs in which each config defines an action to take for some URL match.",
+"items": {
+"$ref": "UrlFilter"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"UrlList": {
"description": "UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns.",
"id": "UrlList",
diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json
index c81eb11..1daa5d7 100644
--- a/googleapiclient/discovery_cache/documents/networkservices.v1.json
+++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json
@@ -135,7 +135,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "networkservices.projects.locations.list",
@@ -3191,7 +3191,7 @@
}
}
},
-"revision": "20251203",
+"revision": "20260204",
"rootUrl": "https://networkservices.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -6042,6 +6042,13 @@
"readOnly": true,
"type": "string"
},
+"targetProxies": {
+"description": "Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
"updateTime": {
"description": "Output only. The timestamp when the resource was updated.",
"format": "google-datetime",
diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json
index fa055c2..1d953d5 100644
--- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json
@@ -135,7 +135,7 @@
]
},
"list": {
-"description": "Lists information about the supported locations for this service.",
+"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1beta1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "networkservices.projects.locations.list",
@@ -3100,7 +3100,7 @@
}
}
},
-"revision": "20251203",
+"revision": "20260204",
"rootUrl": "https://networkservices.googleapis.com/",
"schemas": {
"AuthzExtension": {
@@ -5878,6 +5878,13 @@
"readOnly": true,
"type": "string"
},
+"targetProxies": {
+"description": "Optional. TargetProxies defines a list of TargetTcpProxies this TlsRoute is attached to, as one of the routing rules to route the requests served by the TargetTcpProxy. Each TargetTcpProxy reference should match the pattern: `projects/*/locations/*/targetTcpProxies/`",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
"updateTime": {
"description": "Output only. The timestamp when the resource was updated.",
"format": "google-datetime",
diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json
index 5732a2c..c64e187 100644
--- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json
+++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json
@@ -344,7 +344,7 @@
}
}
},
-"revision": "20260202",
+"revision": "20260209",
"rootUrl": "https://ondemandscanning.googleapis.com/",
"schemas": {
"AliasContext": {
@@ -525,6 +525,10 @@
"description": "The name of the base image.",
"type": "string"
},
+"registry": {
+"description": "The registry in which the base image is from.",
+"type": "string"
+},
"repository": {
"description": "The repository name in which the base image is from.",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json
index b6a4060..da4477a 100644
--- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json
@@ -344,7 +344,7 @@
}
}
},
-"revision": "20260202",
+"revision": "20260209",
"rootUrl": "https://ondemandscanning.googleapis.com/",
"schemas": {
"AliasContext": {
@@ -520,6 +520,10 @@
"description": "The name of the base image.",
"type": "string"
},
+"registry": {
+"description": "The registry in which the base image is from.",
+"type": "string"
+},
"repository": {
"description": "The repository name in which the base image is from.",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json
index 46766a7..cbdcf0f 100644
--- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json
+++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json
@@ -15,6 +15,13 @@
"description": "The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/oracle/database/docs",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://oracledatabase.asia-northeast2.rep.googleapis.com/",
+"location": "asia-northeast2"
+}
+],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -2472,7 +2479,7 @@
}
}
},
-"revision": "20260127",
+"revision": "20260212",
"rootUrl": "https://oracledatabase.googleapis.com/",
"schemas": {
"AllConnectionStrings": {
diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json
index 94ab05b..0a23f49 100644
--- a/googleapiclient/discovery_cache/documents/places.v1.json
+++ b/googleapiclient/discovery_cache/documents/places.v1.json
@@ -280,7 +280,7 @@
}
}
},
-"revision": "20260104",
+"revision": "20260208",
"rootUrl": "https://places.googleapis.com/",
"schemas": {
"GoogleGeoTypeViewport": {
@@ -1134,6 +1134,10 @@
"$ref": "GoogleMapsPlacesV1PlaceGoogleMapsLinks",
"description": "Links to trigger different Google Maps actions."
},
+"googleMapsTypeLabel": {
+"$ref": "GoogleTypeLocalizedText",
+"description": "The type label of the place on Google Maps, localized to the request language if applicable, for example, \"Restaurant\", \"Cafe\", \"Airport\", etc. The type label may be different from the primary type display name and may not be a supported type in [Places API Place Types table](https://developers.google.com/maps/documentation/places/web-service/place-types)."
+},
"googleMapsUri": {
"description": "A URL providing more information about this place.",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json
index e0debcb..fd2e585 100644
--- a/googleapiclient/discovery_cache/documents/recommender.v1.json
+++ b/googleapiclient/discovery_cache/documents/recommender.v1.json
@@ -1686,7 +1686,7 @@
}
}
},
-"revision": "20241013",
+"revision": "20260208",
"rootUrl": "https://recommender.googleapis.com/",
"schemas": {
"GoogleCloudRecommenderV1CostProjection": {
@@ -1739,13 +1739,6 @@
"$ref": "GoogleCloudRecommenderV1CostProjection",
"description": "Use with CategoryType.COST"
},
-"impactComponents": {
-"description": "If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.",
-"items": {
-"$ref": "GoogleCloudRecommenderV1Impact"
-},
-"type": "array"
-},
"reliabilityProjection": {
"$ref": "GoogleCloudRecommenderV1ReliabilityProjection",
"description": "Use with CategoryType.RELIABILITY"
diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json
index af02be8..aeed293 100644
--- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json
@@ -1944,7 +1944,7 @@
}
}
},
-"revision": "20251026",
+"revision": "20260208",
"rootUrl": "https://recommender.googleapis.com/",
"schemas": {
"GoogleCloudLocationListLocationsResponse": {
@@ -2063,13 +2063,6 @@
"$ref": "GoogleCloudRecommenderV1beta1CostProjection",
"description": "Use with CategoryType.COST"
},
-"impactComponents": {
-"description": "If populated, the impact contains multiple components. In this case, the top-level impact contains aggregated values and each component contains per-service details.",
-"items": {
-"$ref": "GoogleCloudRecommenderV1beta1Impact"
-},
-"type": "array"
-},
"reliabilityProjection": {
"$ref": "GoogleCloudRecommenderV1beta1ReliabilityProjection",
"description": "Use with CategoryType.RELIABILITY"
diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json
index 5d89e42..2fe3381 100644
--- a/googleapiclient/discovery_cache/documents/redis.v1.json
+++ b/googleapiclient/discovery_cache/documents/redis.v1.json
@@ -134,6 +134,31 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"getSharedRegionalCertificateAuthority": {
+"description": "Gets the details of regional certificate authority information for Redis cluster.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sharedRegionalCertificateAuthority",
+"httpMethod": "GET",
+"id": "redis.projects.locations.getSharedRegionalCertificateAuthority",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Regional certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority` where `location_id` refers to a Google Cloud region.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sharedRegionalCertificateAuthority$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "SharedRegionalCertificateAuthority"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"list": {
"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1/projects/{projectsId}/locations",
@@ -1078,7 +1103,7 @@
}
}
},
-"revision": "20260129",
+"revision": "20260210",
"rootUrl": "https://redis.googleapis.com/",
"schemas": {
"AOFConfig": {
@@ -1706,6 +1731,10 @@
"format": "int32",
"type": "integer"
},
+"rotateServerCertificate": {
+"description": "Optional. Input only. Rotate the server certificates.",
+"type": "boolean"
+},
"satisfiesPzi": {
"description": "Optional. Output only. Reserved for future use.",
"readOnly": true,
@@ -1716,6 +1745,26 @@
"readOnly": true,
"type": "boolean"
},
+"serverCaMode": {
+"description": "Optional. Server CA mode for the cluster.",
+"enum": [
+"SERVER_CA_MODE_UNSPECIFIED",
+"SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA",
+"SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA",
+"SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA"
+],
+"enumDescriptions": [
+"Server CA mode not specified.",
+"Each cluster has its own Google managed CA.",
+"The cluster uses Google managed shared CA in the region.",
+"The cluster uses customer managed CA from CAS."
+],
+"type": "string"
+},
+"serverCaPool": {
+"description": "Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: \"projects/{project}/locations/{region}/caPools/{ca_pool}\".",
+"type": "string"
+},
"shardCount": {
"description": "Optional. Number of shards for the Redis cluster.",
"format": "int32",
@@ -4889,6 +4938,34 @@
},
"type": "object"
},
+"RegionalCertChain": {
+"description": "The certificates that form the CA chain, from leaf to root order.",
+"id": "RegionalCertChain",
+"properties": {
+"certificates": {
+"description": "The certificates that form the CA chain, from leaf to root order.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"RegionalManagedCertificateAuthority": {
+"description": "CA certificate chains for redis managed server authentication.",
+"id": "RegionalManagedCertificateAuthority",
+"properties": {
+"caCerts": {
+"description": "The PEM encoded CA certificate chains for redis managed server authentication",
+"items": {
+"$ref": "RegionalCertChain"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"RemoteCluster": {
"description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.",
"id": "RemoteCluster",
@@ -4998,6 +5075,10 @@
"description": "MaintenanceInfo to capture the maintenance details of database resource.",
"id": "ResourceMaintenanceInfo",
"properties": {
+"currentVersionReleaseDate": {
+"$ref": "Date",
+"description": "Optional. The date when the current maintenance version was released."
+},
"denyMaintenanceSchedules": {
"description": "Optional. List of Deny maintenance period for the database resource.",
"items": {
@@ -5043,11 +5124,6 @@
"upcomingMaintenance": {
"$ref": "UpcomingMaintenance",
"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window."
-},
-"versionUpdateTime": {
-"description": "Optional. This field will contain the date when the last version update was applied to the database resource. This will be used to calculate the age of the maintenance version.",
-"format": "google-datetime",
-"type": "string"
}
},
"type": "object"
@@ -5149,6 +5225,21 @@
},
"type": "object"
},
+"SharedRegionalCertificateAuthority": {
+"description": "Shared regional certificate authority",
+"id": "SharedRegionalCertificateAuthority",
+"properties": {
+"managedServerCa": {
+"$ref": "RegionalManagedCertificateAuthority",
+"description": "CA certificate chains for redis managed server authentication."
+},
+"name": {
+"description": "Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project}/locations/{location}/sharedRegionalCertificateAuthority`",
+"type": "string"
+}
+},
+"type": "object"
+},
"StateInfo": {
"description": "Represents additional information about the state of the cluster.",
"id": "StateInfo",
diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json
index efdf551..dad6951 100644
--- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json
@@ -134,6 +134,31 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"getSharedRegionalCertificateAuthority": {
+"description": "Gets the details of regional certificate authority information for Redis cluster.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/sharedRegionalCertificateAuthority",
+"httpMethod": "GET",
+"id": "redis.projects.locations.getSharedRegionalCertificateAuthority",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Regional certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/sharedRegionalCertificateAuthority` where `location_id` refers to a Google Cloud region.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sharedRegionalCertificateAuthority$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "SharedRegionalCertificateAuthority"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"list": {
"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v1beta1/projects/{projectsId}/locations",
@@ -1078,7 +1103,7 @@
}
}
},
-"revision": "20260129",
+"revision": "20260210",
"rootUrl": "https://redis.googleapis.com/",
"schemas": {
"AOFConfig": {
@@ -1706,6 +1731,10 @@
"format": "int32",
"type": "integer"
},
+"rotateServerCertificate": {
+"description": "Optional. Input only. Rotate the server certificates.",
+"type": "boolean"
+},
"satisfiesPzi": {
"description": "Optional. Output only. Reserved for future use.",
"readOnly": true,
@@ -1716,6 +1745,26 @@
"readOnly": true,
"type": "boolean"
},
+"serverCaMode": {
+"description": "Optional. Server CA mode for the cluster.",
+"enum": [
+"SERVER_CA_MODE_UNSPECIFIED",
+"SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA",
+"SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA",
+"SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA"
+],
+"enumDescriptions": [
+"Server CA mode not specified.",
+"Each cluster has its own Google managed CA.",
+"The cluster uses Google managed shared CA in the region.",
+"The cluster uses customer managed CA from CAS."
+],
+"type": "string"
+},
+"serverCaPool": {
+"description": "Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: \"projects/{project}/locations/{region}/caPools/{ca_pool}\".",
+"type": "string"
+},
"shardCount": {
"description": "Optional. Number of shards for the Redis cluster.",
"format": "int32",
@@ -4896,6 +4945,34 @@
},
"type": "object"
},
+"RegionalCertChain": {
+"description": "The certificates that form the CA chain, from leaf to root order.",
+"id": "RegionalCertChain",
+"properties": {
+"certificates": {
+"description": "The certificates that form the CA chain, from leaf to root order.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"RegionalManagedCertificateAuthority": {
+"description": "CA certificate chains for redis managed server authentication.",
+"id": "RegionalManagedCertificateAuthority",
+"properties": {
+"caCerts": {
+"description": "The PEM encoded CA certificate chains for redis managed server authentication",
+"items": {
+"$ref": "RegionalCertChain"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"RemoteCluster": {
"description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.",
"id": "RemoteCluster",
@@ -5005,6 +5082,10 @@
"description": "MaintenanceInfo to capture the maintenance details of database resource.",
"id": "ResourceMaintenanceInfo",
"properties": {
+"currentVersionReleaseDate": {
+"$ref": "Date",
+"description": "Optional. The date when the current maintenance version was released."
+},
"denyMaintenanceSchedules": {
"description": "Optional. List of Deny maintenance period for the database resource.",
"items": {
@@ -5050,11 +5131,6 @@
"upcomingMaintenance": {
"$ref": "UpcomingMaintenance",
"description": "Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window."
-},
-"versionUpdateTime": {
-"description": "Optional. This field will contain the date when the last version update was applied to the database resource. This will be used to calculate the age of the maintenance version.",
-"format": "google-datetime",
-"type": "string"
}
},
"type": "object"
@@ -5156,6 +5232,21 @@
},
"type": "object"
},
+"SharedRegionalCertificateAuthority": {
+"description": "Shared regional certificate authority",
+"id": "SharedRegionalCertificateAuthority",
+"properties": {
+"managedServerCa": {
+"$ref": "RegionalManagedCertificateAuthority",
+"description": "CA certificate chains for redis managed server authentication."
+},
+"name": {
+"description": "Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project}/locations/{location}/sharedRegionalCertificateAuthority`",
+"type": "string"
+}
+},
+"type": "object"
+},
"StateInfo": {
"description": "Represents additional information about the state of the cluster.",
"id": "StateInfo",
diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json
index 2ec49af..3ca22bb 100644
--- a/googleapiclient/discovery_cache/documents/run.v1.json
+++ b/googleapiclient/discovery_cache/documents/run.v1.json
@@ -4,6 +4,12 @@
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
+},
+"https://www.googleapis.com/auth/run": {
+"description": "See, edit, configure, and delete your Google Cloud Run data and see the email address for your Google Account"
+},
+"https://www.googleapis.com/auth/run.readonly": {
+"description": "See your Google Cloud Run data and the email address of your Google Account"
}
}
}
@@ -643,7 +649,9 @@
"$ref": "Configuration"
},
"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/run",
+"https://www.googleapis.com/auth/run.readonly"
]
},
"list": {
@@ -704,7 +712,9 @@
"$ref": "ListConfigurationsResponse"
},
"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/run",
+"https://www.googleapis.com/auth/run.readonly"
]
}
}
@@ -2304,7 +2314,9 @@
"$ref": "Configuration"
},
"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/run",
+"https://www.googleapis.com/auth/run.readonly"
]
},
"list": {
@@ -2365,7 +2377,9 @@
"$ref": "ListConfigurationsResponse"
},
"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/run",
+"https://www.googleapis.com/auth/run.readonly"
]
}
}
@@ -3457,7 +3471,7 @@
}
}
},
-"revision": "20260130",
+"revision": "20260206",
"rootUrl": "https://run.googleapis.com/",
"schemas": {
"Addressable": {
@@ -5968,6 +5982,11 @@
"description": "Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.",
"type": "string"
},
+"timeout": {
+"description": "Optional. Duration the instance may be active before the system will shut it down.",
+"format": "google-duration",
+"type": "string"
+},
"volumes": {
"description": "Optional. List of volumes that can be mounted by containers belonging to the Instance.",
"items": {
@@ -6845,7 +6864,7 @@
"type": "object"
},
"Revision": {
-"description": "Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision",
+"description": "Revision is an immutable snapshot of code and configuration. A revision references one or more container images. Revisions are created by updates to a Service.",
"id": "Revision",
"properties": {
"apiVersion": {
@@ -6881,7 +6900,7 @@
"type": "integer"
},
"containers": {
-"description": "Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.",
+"description": "Required. Containers holds the list which define the units of execution for this Revision.",
"items": {
"$ref": "Container"
},
diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json
index ad24fcb..a64345f 100644
--- a/googleapiclient/discovery_cache/documents/run.v2.json
+++ b/googleapiclient/discovery_cache/documents/run.v2.json
@@ -2383,7 +2383,7 @@
}
}
},
-"revision": "20260130",
+"revision": "20260206",
"rootUrl": "https://run.googleapis.com/",
"schemas": {
"GoogleCloudRunV2BinaryAuthorization": {
@@ -3580,6 +3580,11 @@
"description": "Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.",
"readOnly": true
},
+"timeout": {
+"description": "Optional. Duration the instance may be active before the system will shut it down.",
+"format": "google-duration",
+"type": "string"
+},
"uid": {
"description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.",
"readOnly": true,
@@ -4166,7 +4171,7 @@
"type": "array"
},
"containers": {
-"description": "Holds the single container that defines the unit of execution for this Revision.",
+"description": "Containers holds the list which define the units of execution for this Revision.",
"items": {
"$ref": "GoogleCloudRunV2Container"
},
@@ -4375,6 +4380,16 @@
"description": "Settings for revision-level scaling settings.",
"id": "GoogleCloudRunV2RevisionScaling",
"properties": {
+"concurrencyUtilization": {
+"description": "Optional. Determines a threshold for concurrency utilization before scaling begins.",
+"format": "float",
+"type": "number"
+},
+"cpuUtilization": {
+"description": "Optional. Determines a threshold for CPU utilization before scaling begins.",
+"format": "float",
+"type": "number"
+},
"maxInstanceCount": {
"description": "Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances",
"format": "int32",
diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json
index a79439d..9692602 100644
--- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json
+++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json
@@ -245,7 +245,7 @@
],
"parameters": {
"pageSize": {
-"description": "Optional. The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If `page_size` isn't provided or the size provided is a number larger than 1000, it's automatically set to 1000.",
+"description": "Optional. The maximum number of results returned by this request. Currently, the default maximum is set to 256. If `page_size` <= 256, the request proceeds. Else, the request fails with an `TU_INVALID_PAGE_SIZE` error.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -547,7 +547,7 @@
}
}
},
-"revision": "20260120",
+"revision": "20260210",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"AddTenantProjectRequest": {
@@ -646,6 +646,13 @@
"description": "The type of this aspect configuration.",
"type": "string"
},
+"rules": {
+"description": "Optional. Rules of the Configuration.",
+"items": {
+"$ref": "AspectRule"
+},
+"type": "array"
+},
"spec": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -657,6 +664,25 @@
},
"type": "object"
},
+"AspectRule": {
+"description": "Rule-based configuration for an aspect.",
+"id": "AspectRule",
+"properties": {
+"config": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. Rules of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.",
+"type": "object"
+},
+"selector": {
+"description": "Required. Selects the RPC methods to which this rule applies. Refer to selector for syntax details.",
+"type": "string"
+}
+},
+"type": "object"
+},
"AttachTenantProjectRequest": {
"description": "Request to attach an existing project to the tenancy unit as a new tenant resource.",
"id": "AttachTenantProjectRequest",
diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json
index 9562ed9..14d01f4 100644
--- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json
@@ -724,7 +724,7 @@
}
}
},
-"revision": "20260120",
+"revision": "20260210",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"Api": {
@@ -793,6 +793,13 @@
"description": "The type of this aspect configuration.",
"type": "string"
},
+"rules": {
+"description": "Optional. Rules of the Configuration.",
+"items": {
+"$ref": "AspectRule"
+},
+"type": "array"
+},
"spec": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -804,6 +811,25 @@
},
"type": "object"
},
+"AspectRule": {
+"description": "Rule-based configuration for an aspect.",
+"id": "AspectRule",
+"properties": {
+"config": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. Rules of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.",
+"type": "object"
+},
+"selector": {
+"description": "Required. Selects the RPC methods to which this rule applies. Refer to selector for syntax details.",
+"type": "string"
+}
+},
+"type": "object"
+},
"AuthProvider": {
"description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"id": "AuthProvider",
diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json
index 6726acc..11dd3c7 100644
--- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json
+++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json
@@ -431,7 +431,7 @@
}
}
},
-"revision": "20260120",
+"revision": "20260210",
"rootUrl": "https://serviceusage.googleapis.com/",
"schemas": {
"AddEnableRulesMetadata": {
@@ -638,6 +638,13 @@
"description": "The type of this aspect configuration.",
"type": "string"
},
+"rules": {
+"description": "Optional. Rules of the Configuration.",
+"items": {
+"$ref": "AspectRule"
+},
+"type": "array"
+},
"spec": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -649,6 +656,25 @@
},
"type": "object"
},
+"AspectRule": {
+"description": "Rule-based configuration for an aspect.",
+"id": "AspectRule",
+"properties": {
+"config": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. Rules of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.",
+"type": "object"
+},
+"selector": {
+"description": "Required. Selects the RPC methods to which this rule applies. Refer to selector for syntax details.",
+"type": "string"
+}
+},
+"type": "object"
+},
"AuthProvider": {
"description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"id": "AuthProvider",
diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json
index a89bb06..fe3656f 100644
--- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json
@@ -969,7 +969,7 @@
}
}
},
-"revision": "20260120",
+"revision": "20260210",
"rootUrl": "https://serviceusage.googleapis.com/",
"schemas": {
"AddEnableRulesMetadata": {
@@ -1176,6 +1176,13 @@
"description": "The type of this aspect configuration.",
"type": "string"
},
+"rules": {
+"description": "Optional. Rules of the Configuration.",
+"items": {
+"$ref": "AspectRule"
+},
+"type": "array"
+},
"spec": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -1187,6 +1194,25 @@
},
"type": "object"
},
+"AspectRule": {
+"description": "Rule-based configuration for an aspect.",
+"id": "AspectRule",
+"properties": {
+"config": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. Rules of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.",
+"type": "object"
+},
+"selector": {
+"description": "Required. Selects the RPC methods to which this rule applies. Refer to selector for syntax details.",
+"type": "string"
+}
+},
+"type": "object"
+},
"AuthProvider": {
"description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"id": "AuthProvider",
diff --git a/googleapiclient/discovery_cache/documents/solar.v1.json b/googleapiclient/discovery_cache/documents/solar.v1.json
index 5c70369..8c77836 100644
--- a/googleapiclient/discovery_cache/documents/solar.v1.json
+++ b/googleapiclient/discovery_cache/documents/solar.v1.json
@@ -304,7 +304,7 @@
}
}
},
-"revision": "20260125",
+"revision": "20260208",
"rootUrl": "https://solar.googleapis.com/",
"schemas": {
"BuildingInsights": {
@@ -454,7 +454,7 @@
"type": "string"
},
"rgbUrl": {
-"description": "The URL for an image of RGB data (aerial photo) of the region.",
+"description": "The URL for an image of RGB data (aerial or satellite photo) of the region.",
"type": "string"
}
},
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
index 92adba9..4136a67 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
@@ -1797,41 +1797,6 @@
"https://www.googleapis.com/auth/sqlservice.admin"
]
},
-"restoreBackupMcp": {
-"description": "Restores a backup of a Cloud SQL instance for Model Context Protocol (MCP) server.",
-"flatPath": "v1/projects/{targetProject}/instances/{targetInstance}:restoreBackupMcp",
-"httpMethod": "POST",
-"id": "sql.instances.restoreBackupMcp",
-"parameterOrder": [
-"targetProject",
-"targetInstance"
-],
-"parameters": {
-"targetInstance": {
-"description": "Required. Cloud SQL instance ID of the target. This does not include the project ID.",
-"location": "path",
-"required": true,
-"type": "string"
-},
-"targetProject": {
-"description": "Required. Project ID of the target project.",
-"location": "path",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/projects/{targetProject}/instances/{targetInstance}:restoreBackupMcp",
-"request": {
-"$ref": "SqlInstancesRestoreBackupMcpRequest"
-},
-"response": {
-"$ref": "Operation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/sqlservice.admin"
-]
-},
"rotateServerCa": {
"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.",
"flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCa",
@@ -2808,6 +2773,11 @@
"location": "path",
"required": true,
"type": "string"
+},
+"revokeExistingRoles": {
+"description": "Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles.",
+"location": "query",
+"type": "boolean"
}
},
"path": "v1/projects/{project}/instances/{instance}/users",
@@ -2825,7 +2795,7 @@
}
}
},
-"revision": "20260119",
+"revision": "20260204",
"rootUrl": "https://sqladmin.googleapis.com/",
"schemas": {
"AclEntry": {
@@ -3022,7 +2992,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -3075,6 +3048,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -3128,7 +3104,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"readOnly": true,
"type": "string"
@@ -3487,7 +3466,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -3540,6 +3522,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -3593,7 +3578,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"readOnly": true,
"type": "string"
@@ -3775,6 +3763,14 @@
"description": "Required. Name of the Cloud SQL instance to be created as a clone.",
"type": "string"
},
+"destinationNetwork": {
+"description": "Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:`projects/my-network-project/global/networks/my-network`. This field is only required for cross-project cloning.",
+"type": "string"
+},
+"destinationProject": {
+"description": "Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.",
+"type": "string"
+},
"kind": {
"description": "This is always `sql#cloneContext`.",
"type": "string"
@@ -3939,7 +3935,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -3992,6 +3991,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -4045,7 +4047,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
},
@@ -4347,7 +4352,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -4400,6 +4408,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -4453,7 +4464,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
},
@@ -5325,7 +5339,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -5378,6 +5395,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -5431,7 +5451,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
},
@@ -7182,7 +7205,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -7235,6 +7261,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -7288,7 +7317,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
}
@@ -8234,25 +8266,6 @@
"properties": {},
"type": "object"
},
-"SqlInstancesRestoreBackupMcpRequest": {
-"description": "Instance restore backup request for MCP.",
-"id": "SqlInstancesRestoreBackupMcpRequest",
-"properties": {
-"backupId": {
-"description": "Required. The identifier of the backup to restore. This will be one of the following: 1. An int64 containing a backup_run_id. 2. A backup name of the format 'projects/{project}/backups/{backup-uid}'. 3. A backupDR name of the format 'projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}'.",
-"type": "string"
-},
-"sourceInstance": {
-"description": "Optional. The Cloud SQL instance ID of the source instance containing the backup. Only necessary if the backup_id is a backup_run_id.",
-"type": "string"
-},
-"sourceProject": {
-"description": "Required. The project ID of the source instance containing the backup.",
-"type": "string"
-}
-},
-"type": "object"
-},
"SqlInstancesStartExternalSyncRequest": {
"description": "Instance start external sync request.",
"id": "SqlInstancesStartExternalSyncRequest",
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
index 4cb3805..c925b29 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
@@ -2775,7 +2775,7 @@
"type": "string"
},
"revokeExistingRoles": {
-"description": "Optional. revoke the existing roles granted to the user.",
+"description": "Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles.",
"location": "query",
"type": "boolean"
}
@@ -2795,7 +2795,7 @@
}
}
},
-"revision": "20260106",
+"revision": "20260204",
"rootUrl": "https://sqladmin.googleapis.com/",
"schemas": {
"AclEntry": {
@@ -2992,7 +2992,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -3045,6 +3048,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -3098,7 +3104,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"readOnly": true,
"type": "string"
@@ -3457,7 +3466,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -3510,6 +3522,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -3563,7 +3578,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"readOnly": true,
"type": "string"
@@ -3745,6 +3763,14 @@
"description": "Name of the Cloud SQL instance to be created as a clone.",
"type": "string"
},
+"destinationNetwork": {
+"description": "Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:`projects/my-network-project/global/networks/my-network`. This field is only required for cross-project cloning.",
+"type": "string"
+},
+"destinationProject": {
+"description": "Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.",
+"type": "string"
+},
"kind": {
"description": "This is always `sql#cloneContext`.",
"type": "string"
@@ -3909,7 +3935,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -3962,6 +3991,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -4015,7 +4047,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
},
@@ -4317,7 +4352,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -4370,6 +4408,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -4423,7 +4464,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
},
@@ -5296,7 +5340,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -5349,6 +5396,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -5402,7 +5452,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
},
@@ -7153,7 +7206,10 @@
"SQLSERVER_2022_STANDARD",
"SQLSERVER_2022_ENTERPRISE",
"SQLSERVER_2022_EXPRESS",
-"SQLSERVER_2022_WEB"
+"SQLSERVER_2022_WEB",
+"SQLSERVER_2025_STANDARD",
+"SQLSERVER_2025_ENTERPRISE",
+"SQLSERVER_2025_EXPRESS"
],
"enumDeprecated": [
false,
@@ -7206,6 +7262,9 @@
false,
false,
false,
+false,
+false,
+false,
false
],
"enumDescriptions": [
@@ -7259,7 +7318,10 @@
"The database version is SQL Server 2022 Standard.",
"The database version is SQL Server 2022 Enterprise.",
"The database version is SQL Server 2022 Express.",
-"The database version is SQL Server 2022 Web."
+"The database version is SQL Server 2022 Web.",
+"The database version is SQL Server 2025 Standard.",
+"The database version is SQL Server 2025 Enterprise.",
+"The database version is SQL Server 2025 Express."
],
"type": "string"
}
diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json
index 15bc064..8446cd4 100644
--- a/googleapiclient/discovery_cache/documents/storage.v1.json
+++ b/googleapiclient/discovery_cache/documents/storage.v1.json
@@ -253,7 +253,7 @@
"location": "northamerica-south1"
}
],
-"etag": "\"3130353639373731363639313032363439383430\"",
+"etag": "\"31363539393037303230303637393438373935\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
"x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
@@ -1784,6 +1784,50 @@
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
+"deleteRecursive": {
+"description": "Deletes a folder recursively. Only applicable to buckets with hierarchical namespace enabled.",
+"httpMethod": "POST",
+"id": "storage.folders.deleteRecursive",
+"parameterOrder": [
+"bucket",
+"folder"
+],
+"parameters": {
+"bucket": {
+"description": "Name of the bucket in which the folder resides.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"folder": {
+"description": "Name of a folder.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"ifMetagenerationMatch": {
+"description": "If set, only deletes the folder if its metageneration matches this value.",
+"format": "int64",
+"location": "query",
+"type": "string"
+},
+"ifMetagenerationNotMatch": {
+"description": "If set, only deletes the folder if its metageneration does not match this value.",
+"format": "int64",
+"location": "query",
+"type": "string"
+}
+},
+"path": "b/{bucket}/folders/{folder}/deleteRecursive",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/devstorage.full_control",
+"https://www.googleapis.com/auth/devstorage.read_write"
+]
+},
"get": {
"description": "Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.",
"httpMethod": "GET",
@@ -4561,7 +4605,7 @@
}
}
},
-"revision": "20260131",
+"revision": "20260204",
"rootUrl": "https://storage.googleapis.com/",
"schemas": {
"AdvanceRelocateBucketOperationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json
index bc8f735..0c9b65c 100644
--- a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json
+++ b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json
@@ -569,7 +569,7 @@
}
}
},
-"revision": "20260128",
+"revision": "20260204",
"rootUrl": "https://storagebatchoperations.googleapis.com/",
"schemas": {
"Bucket": {
@@ -893,6 +893,11 @@
"readOnly": true,
"type": "array"
},
+"isMultiBucketJob": {
+"description": "Output only. If true, this Job operates on multiple buckets. Multibucket jobs are subject to different quota limits than single-bucket jobs.",
+"readOnly": true,
+"type": "boolean"
+},
"loggingConfig": {
"$ref": "LoggingConfig",
"description": "Optional. Logging configuration."
@@ -926,14 +931,16 @@
"RUNNING",
"SUCCEEDED",
"CANCELED",
-"FAILED"
+"FAILED",
+"QUEUED"
],
"enumDescriptions": [
"Default value. This value is unused.",
"In progress.",
"Completed successfully.",
"Cancelled by the user.",
-"Terminated due to an unrecoverable failure."
+"Terminated due to an unrecoverable failure.",
+"Queued but not yet started."
],
"readOnly": true,
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json
index 4ba9c05..65f50b0 100644
--- a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json
@@ -14,7 +14,29 @@
"canonicalName": "Threat Intelligence Service",
"description": "threatintelligence.googleapis.com API.",
"discoveryVersion": "v1",
-"documentationLink": "https://cloud.google.com/threatintelligence/docs/reference/rest",
+"documentationLink": "https://docs.cloud.google.com/threatintelligence/",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://threatintelligence.us-central1.rep.googleapis.com/",
+"location": "us-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://threatintelligence.us-east5.rep.googleapis.com/",
+"location": "us-east5"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://threatintelligence.us-west2.rep.googleapis.com/",
+"location": "us-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://threatintelligence.us.rep.googleapis.com/",
+"location": "us"
+}
+],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -866,7 +888,7 @@
}
}
},
-"revision": "20260204",
+"revision": "20260211",
"rootUrl": "https://threatintelligence.googleapis.com/",
"schemas": {
"AffectedSoftware": {
diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json
index 1491cdf..02614d6 100644
--- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json
+++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json
@@ -2713,7 +2713,7 @@
}
}
},
-"revision": "20260204",
+"revision": "20260213",
"rootUrl": "https://walletobjects.googleapis.com/",
"schemas": {
"ActivationOptions": {
@@ -4144,7 +4144,7 @@
"type": "array"
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
+"description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -4417,7 +4417,7 @@
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the object.",
+"description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -4930,7 +4930,7 @@
"type": "array"
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
+"description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -5211,7 +5211,7 @@
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the object.",
+"description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -5372,7 +5372,7 @@
"type": "array"
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
+"description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -5613,7 +5613,7 @@
"description": "The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the object.",
+"description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -5894,7 +5894,7 @@
"type": "array"
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
+"description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -6148,7 +6148,7 @@
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the object.",
+"description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -6788,7 +6788,7 @@
"type": "array"
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
+"description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -7045,7 +7045,7 @@
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the object.",
+"description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -7831,7 +7831,7 @@
"description": "The title image of the offer. This image is displayed in both the details and list views of the app."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
+"description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -8064,7 +8064,7 @@
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the object.",
+"description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -9279,7 +9279,7 @@
"type": "string"
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
+"description": "Optional value added module data. Maximum of fifteen on the class. For a pass only fifteen will be displayed, prioritizing those from the object.",
"items": {
"$ref": "ValueAddedModuleData"
},
@@ -9675,7 +9675,7 @@
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
},
"valueAddedModuleData": {
-"description": "Optional value added module data. Maximum of ten on the object.",
+"description": "Optional value added module data. Maximum of fifteen on the object. For a pass only fifteen will be displayed.",
"items": {
"$ref": "ValueAddedModuleData"
},
diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json
index b926ce4..35930ce 100644
--- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json
@@ -183,6 +183,284 @@
}
},
"resources": {
+"deployments": {
+"methods": {
+"create": {
+"description": "Creates a new Deployment in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments",
+"httpMethod": "POST",
+"id": "workloadmanager.projects.locations.deployments.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"deploymentId": {
+"description": "Required. Id of the deployment",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/deployments",
+"request": {
+"$ref": "Deployment"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a single Deployment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}",
+"httpMethod": "DELETE",
+"id": "workloadmanager.projects.locations.deployments.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "Optional. If set to true, any actuation will also be deleted. Followed the best practice from https://aip.dev/135#cascading-delete",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. Name of the resource",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets details of a single Deployment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}",
+"httpMethod": "GET",
+"id": "workloadmanager.projects.locations.deployments.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Deployment"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Deployments in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments",
+"httpMethod": "GET",
+"id": "workloadmanager.projects.locations.deployments.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Filter resource follow https://google.aip.dev/160",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. Requested page size. Server may return fewer items than requested. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A token identifying a page of results the server should return.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource prefix of the Deployment using the form: `projects/{project_id}/locations/{location_id}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/deployments",
+"response": {
+"$ref": "ListDeploymentsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"actuations": {
+"methods": {
+"create": {
+"description": "Creates a new actuation for an existing Deployment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations",
+"httpMethod": "POST",
+"id": "workloadmanager.projects.locations.deployments.actuations.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Actuation location using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/actuations",
+"request": {
+"$ref": "Actuation"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a single Actuation",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations/{actuationsId}",
+"httpMethod": "DELETE",
+"id": "workloadmanager.projects.locations.deployments.actuations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the book to delete. project/{project_id}/locations/{location_id}/deployments/{deployment_id}/actuations/{actuation_id}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/actuations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets details of a single Actuation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations/{actuationsId}",
+"httpMethod": "GET",
+"id": "workloadmanager.projects.locations.deployments.actuations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the resource",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/actuations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Actuation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Actuations in a given project, location and deployment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/actuations",
+"httpMethod": "GET",
+"id": "workloadmanager.projects.locations.deployments.actuations.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Filtering results",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A token identifying a page of results the server should return.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource prefix of the Actuation using the form: 'projects/{project_id}/locations/{location}/deployments/{deployment}'",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/actuations",
+"response": {
+"$ref": "ListActuationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
"discoveredprofiles": {
"methods": {
"get": {
@@ -979,9 +1257,190 @@
}
}
},
-"revision": "20260128",
+"revision": "20260204",
"rootUrl": "https://workloadmanager.googleapis.com/",
"schemas": {
+"ActiveDirectory": {
+"description": "Active directory details",
+"id": "ActiveDirectory",
+"properties": {
+"dnsAddress": {
+"description": "Optional. DNS IP address",
+"type": "string"
+},
+"domain": {
+"description": "Optional. human readable form of a domain such as \u201cgoogle.com\u201d.",
+"type": "string"
+},
+"domainUsername": {
+"description": "Optional. domain username",
+"type": "string"
+},
+"secretManagerSecret": {
+"description": "Required. secret_manager_secret",
+"type": "string"
+},
+"type": {
+"description": "Required. active directory type",
+"enum": [
+"ACTIVE_DIRECTORY_TYPE_UNSPECIFIED",
+"GCP_MANAGED",
+"SELF_MANAGED"
+],
+"enumDescriptions": [
+"Unspecified active directory type",
+"GCP managed active directory type",
+"Self managed active directory type"
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"Actuation": {
+"description": "The Actuation object represents the bootstrap state and output results of deployed infrastructure and software.",
+"id": "Actuation",
+"properties": {
+"actuationOutput": {
+"$ref": "ActuationOutput",
+"description": "Output only. [Output only] Actuation output",
+"readOnly": true
+},
+"deploymentOutput": {
+"description": "Output only. [Output only] Deployment output",
+"items": {
+"$ref": "DeploymentOutput"
+},
+"readOnly": true,
+"type": "array"
+},
+"endTime": {
+"description": "Output only. [Output only] End time stamp",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "The name of actuation resource. The format is projects/{project}/locations/{location}/deployments/{deployment}/actuations/{actuation}",
+"type": "string"
+},
+"startTime": {
+"description": "Output only. [Output only] Start time stamp",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"state": {
+"description": "Output only. [Output only] Actuation state",
+"enum": [
+"STATE_UNSPECIFIED",
+"INFRA_CREATING",
+"SUCCEEDED",
+"FAILED",
+"POST_INFRA_CONFIGURING",
+"INFRA_DESTROYING",
+"TIMEOUT"
+],
+"enumDescriptions": [
+"state unspecified",
+"creating infrastructure in backend (terraform applying)",
+"success",
+"failed either in infra creating, post infra configuring or infra destroying",
+"configure workload after infrastructure is ready (ansible running)",
+"destroying infrastructure in backend (terraform destroying)",
+"ansible is timeout due to losing heartbeat in post infra configuring"
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"ActuationOutput": {
+"description": "Message for output of Actuation",
+"id": "ActuationOutput",
+"properties": {
+"actuateLogs": {
+"description": "A link to gcs file that store build logs",
+"type": "string"
+},
+"ansibleError": {
+"description": "Output only. error message return from ansible.",
+"readOnly": true,
+"type": "string"
+},
+"ansibleFailedTask": {
+"description": "Output only. failed task name return from ansible.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"blueprintId": {
+"description": "reference to Blueprint Controller deployment and revision resource",
+"type": "string"
+},
+"cloudbuildId": {
+"description": "Cloud Build instance UUID associated with this revision, without any suffix or prefix",
+"type": "string"
+},
+"errorCode": {
+"description": "Output only. Code describing any errors that may have occurred. If not specified, there is no error in actuation.",
+"enum": [
+"ERROR_CODE_UNSPECIFIED",
+"TERRAFORM_FAILED",
+"PERMISSION_DENIED_IN_TERRAFORM",
+"QUOTA_EXCEED_IN_TERRAFORM",
+"ANSIBLE_FAILED",
+"CONSTRAINT_VIOLATION_IN_TERRAFORM",
+"RESOURCE_ALREADY_EXISTS_IN_TERRAFORM",
+"RESOURCE_UNAVAILABLE_IN_TERRAFORM",
+"PERMISSION_DENIED_IN_ANSIBLE",
+"INVALID_SECRET_IN_ANSIBLE",
+"TERRAFORM_DELETION_FAILED",
+"RESOURCE_IN_USE_IN_TERRAFORM_DELETION",
+"ANSIBLE_START_FAILED"
+],
+"enumDescriptions": [
+"No error code was specified.",
+"general terraform failure",
+"permission error in terraform",
+"quota related error in terraform",
+"general ansible failure",
+"constraint related error in terraform",
+"resource already exists error in terraform",
+"resource not found error in terraform",
+"permission denied error in ansible",
+"secret related error in ansible",
+"general terraform failure during deletion",
+"resource in use error in terraform deletion",
+"start up failure in ansible"
+],
+"readOnly": true,
+"type": "string"
+},
+"errorLogs": {
+"description": "A link to actuation cloud build log.",
+"type": "string"
+},
+"hasUserFacingErrorMsg": {
+"description": "Output only. whether the error message is user facing. If true, the error message will be shown in the UI.",
+"readOnly": true,
+"type": "boolean"
+},
+"terraformError": {
+"description": "Output only. error message return from terraform.",
+"readOnly": true,
+"type": "string"
+},
+"terraformTemplate": {
+"description": "reference to terraform template used",
+"type": "string"
+}
+},
+"type": "object"
+},
"AgentCommand": {
"description": "* An AgentCommand specifies a one-time executable program for the agent to run.",
"id": "AgentCommand",
@@ -1297,6 +1756,81 @@
},
"type": "object"
},
+"AppDetails": {
+"description": "Message for sap instant details",
+"id": "AppDetails",
+"properties": {
+"appInstanceId": {
+"description": "Optional. instance id for app",
+"type": "string"
+},
+"appServiceAccount": {
+"description": "Application service account - let custoemrs bring their own SA for application",
+"type": "string"
+},
+"appVmNames": {
+"description": "Optional. Customized vm names",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"ascsImage": {
+"description": "Required. image for ascs server",
+"type": "string"
+},
+"ascsInstanceId": {
+"description": "Optional. instance id for ascs",
+"type": "string"
+},
+"ascsMachineType": {
+"description": "Required. ascs_machine_type",
+"type": "string"
+},
+"ascsServiceAccount": {
+"description": "ASCS service account - let custoemrs bring their own SA for ASCS",
+"type": "string"
+},
+"ascsVm": {
+"description": "Optional. ASCS vm name",
+"type": "string"
+},
+"ersInstanceId": {
+"description": "Optional. instance id for ers",
+"type": "string"
+},
+"ersVm": {
+"description": "Optional. ERS vm name",
+"type": "string"
+},
+"image": {
+"description": "Required. image for app server and ascs server",
+"type": "string"
+},
+"machineType": {
+"description": "Required. machine type",
+"type": "string"
+},
+"secretManagerSecret": {
+"description": "Required. secret_manager_secret",
+"type": "string"
+},
+"sharedStorage": {
+"description": "Optional. Storage location",
+"type": "string"
+},
+"sid": {
+"description": "Required. The SAP SID is a three-digit server-specific unique identification code.",
+"type": "string"
+},
+"vmsMultiplier": {
+"description": "Required. vms_multiplier",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
"BackupProperties": {
"description": "Backup properties.",
"id": "BackupProperties",
@@ -1471,6 +2005,110 @@
},
"type": "object"
},
+"Database": {
+"description": "Database details",
+"id": "Database",
+"properties": {
+"diskType": {
+"description": "Required. disk_type",
+"type": "string"
+},
+"floatingIpAddress": {
+"description": "Optional. only useful for Linux High Availability setup",
+"type": "string"
+},
+"machineType": {
+"description": "Required. machine type",
+"type": "string"
+},
+"secondarySoleTenantNode": {
+"description": "Optional. the name of a secondary-sole-tenant node/node group",
+"type": "string"
+},
+"secondarySoleTenantNodeType": {
+"description": "Optional. the type of a secondary-sole-tenant node/node group e.g. compute.googleapis.com/node-name",
+"type": "string"
+},
+"secretManagerSecret": {
+"description": "Required. secret_manager_secret",
+"type": "string"
+},
+"smt": {
+"description": "Required. whether simultaneous multithreading is enabled or not",
+"type": "boolean"
+},
+"soleTenantNode": {
+"description": "Optional. the name of a primary sole-tenant node/node group",
+"type": "string"
+},
+"soleTenantNodeType": {
+"description": "Optional. the type of a primary sole-tenant node/node group e.g. compute.googleapis.com/node-name",
+"type": "string"
+},
+"tempdbOnSsd": {
+"description": "Required. whether to have TempDB on local SSD",
+"type": "boolean"
+},
+"tenancyModel": {
+"description": "Required. SHARED or SOLE_TENANT",
+"enum": [
+"TENANCY_MODEL_UNSPECIFIED",
+"SHARED",
+"SOLE_TENANT"
+],
+"enumDescriptions": [
+"Unspecified tenancy model",
+"Shared tenancy model",
+"Sole Tenant tenancy model"
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"DatabaseDetails": {
+"description": "Message for sap instant details",
+"id": "DatabaseDetails",
+"properties": {
+"databaseServiceAccount": {
+"description": "Database service account - let custoemrs bring their own SA for database",
+"type": "string"
+},
+"diskType": {
+"description": "Required. disk_type",
+"type": "string"
+},
+"image": {
+"description": "Required. image for database server",
+"type": "string"
+},
+"instanceId": {
+"description": "Optional. instance id",
+"type": "string"
+},
+"machineType": {
+"description": "Required. machine type",
+"type": "string"
+},
+"primaryDbVm": {
+"description": "Optional. primary db vm name",
+"type": "string"
+},
+"secondaryDbVm": {
+"description": "Optional. secondary db vm name",
+"type": "string"
+},
+"secretManagerSecret": {
+"description": "Required. secret_manager_secret",
+"type": "string"
+},
+"sid": {
+"description": "Required. The SID is a three-digit server-specific unique identification code.",
+"type": "string"
+}
+},
+"type": "object"
+},
"DatabaseProperties": {
"description": "Database Properties.",
"id": "DatabaseProperties",
@@ -1506,6 +2144,108 @@
},
"type": "object"
},
+"Deployment": {
+"description": "The Deployment object represents user intent for deploying a specific type of workload.",
+"id": "Deployment",
+"properties": {
+"createTime": {
+"description": "Output only. [Output only] Create time stamp",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"description": {
+"description": "Description of the Deployment",
+"type": "string"
+},
+"name": {
+"description": "The name of deployment resource. The format will be 'projects/{project_id}/locations/{location_id}/deployments/{deployment_id}'",
+"type": "string"
+},
+"sapSystemS4Config": {
+"$ref": "SapSystemS4Config",
+"description": "SAP system workload input"
+},
+"serviceAccount": {
+"description": "User-specified Service Account (SA) credentials to be used for cloud build Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` The default Cloud Build SA will be used initially if this field is not set during deployment creation",
+"type": "string"
+},
+"sqlServerWorkload": {
+"$ref": "SqlServerWorkload",
+"description": "MS SQL workload input"
+},
+"state": {
+"description": "Output only. Current state of the deployment.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"UPDATING",
+"DELETING",
+"FAILED"
+],
+"enumDescriptions": [
+"The default value. This value is used if the state is omitted.",
+"The deployment is being created.",
+"The deployment is healthy.",
+"The deployment is being updated.",
+"The deployment is being deleted.",
+"The deployment has encountered an unexpected error."
+],
+"readOnly": true,
+"type": "string"
+},
+"terraformVariables": {
+"additionalProperties": {
+"$ref": "TerraformVariable"
+},
+"description": "Optional. terraform_variables represents all the Terraform variables for the deployment workload. The key is the name of the Terraform variable, and the value is the TerraformVariable. For example: { \"project_id\": { \"input_value\": { \"string_value\": \"my-project-id\" } }, \"zone\": { \"input_value\": { \"string_value\": \"us-central1-a\" } } }",
+"type": "object"
+},
+"updateTime": {
+"description": "Output only. [Output only] Update time stamp",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"workerPool": {
+"description": "Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.",
+"type": "string"
+},
+"workloadType": {
+"description": "Optional. Workload type of the deployment",
+"enum": [
+"WORKLOAD_TYPE_UNSPECIFIED",
+"SAP_S4",
+"SQL_SERVER",
+"ORACLE"
+],
+"enumDescriptions": [
+"Unspecified workload type",
+"SAP S/4HANA workload type",
+"SQL Server workload type",
+"Oracle workload type"
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"DeploymentOutput": {
+"description": "Message for output of deployment resource",
+"id": "DeploymentOutput",
+"properties": {
+"name": {
+"description": "name of the resource",
+"type": "string"
+},
+"type": {
+"description": "type of the resource",
+"type": "string"
+}
+},
+"type": "object"
+},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
@@ -2015,6 +2755,56 @@
},
"type": "object"
},
+"ListActuationsResponse": {
+"description": "The response object from `ListActuations`.",
+"id": "ListActuationsResponse",
+"properties": {
+"actuations": {
+"description": "The list of Actuation",
+"items": {
+"$ref": "Actuation"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+},
+"unreachable": {
+"description": "Unordered list. Locations that could not be reached.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"ListDeploymentsResponse": {
+"description": "Message for response to listing Deployments",
+"id": "ListDeploymentsResponse",
+"properties": {
+"deployments": {
+"description": "The list of Deployment",
+"items": {
+"$ref": "Deployment"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token identifying a page of results the server should return.",
+"type": "string"
+},
+"unreachable": {
+"description": "Unordered list. Locations that could not be reached.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"ListDiscoveredProfilesResponse": {
"description": "List discovered profile Response returns discovered profiles from agents",
"id": "ListDiscoveredProfilesResponse",
@@ -2223,6 +3013,73 @@
},
"type": "object"
},
+"LocationDetails": {
+"description": "Message for sap instant details",
+"id": "LocationDetails",
+"properties": {
+"createCommsFirewall": {
+"description": "Optional. create firewall, if true, create firewall for the deployment. This field provides an option to not always create firewall for the deployment.",
+"type": "boolean"
+},
+"customTags": {
+"description": "Optional. network tags",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"deploymentDnsEnabled": {
+"description": "Optional. when user skip DNS configuration from UI, deployment_dns_enabled=false otherwise deployment_dns_enabled=true",
+"type": "boolean"
+},
+"dnsZone": {
+"description": "Optional. dns zone name",
+"type": "string"
+},
+"dnsZoneNameSuffix": {
+"description": "Optional. dns_zone_name_suffix",
+"type": "string"
+},
+"internetAccess": {
+"enum": [
+"INTERNETACCESS_UNSPECIFIED",
+"ALLOW_EXTERNAL_IP",
+"CONFIGURE_NAT"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"networkProject": {
+"description": "Optional. network project",
+"type": "string"
+},
+"regionName": {
+"description": "Required. region_name",
+"type": "string"
+},
+"subnetName": {
+"description": "Required. subnet_name",
+"type": "string"
+},
+"vpcName": {
+"description": "Required. vpc_name",
+"type": "string"
+},
+"zone1Name": {
+"description": "Required. zone1_name",
+"type": "string"
+},
+"zone2Name": {
+"description": "Optional. zone2_name",
+"type": "string"
+}
+},
+"type": "object"
+},
"Notice": {
"description": "Message for additional information generated by the execution",
"id": "Notice",
@@ -2333,6 +3190,37 @@
},
"type": "object"
},
+"Pacemaker": {
+"description": "pacemaker configuration",
+"id": "Pacemaker",
+"properties": {
+"bucketNameNodeCertificates": {
+"description": "Required. bucket location for node certificates",
+"type": "string"
+},
+"pacemakerCluster": {
+"description": "Required. pacemaker cluster name",
+"type": "string"
+},
+"pacemakerClusterSecret": {
+"description": "Required. pacemaker cluster secret name",
+"type": "string"
+},
+"pacemakerClusterUsername": {
+"description": "Required. pacemaker cluster username",
+"type": "string"
+},
+"sqlPacemakerSecret": {
+"description": "Required. sql pacemaker secret name",
+"type": "string"
+},
+"sqlPacemakerUsername": {
+"description": "Required. sql pacemaker username",
+"type": "string"
+}
+},
+"type": "object"
+},
"Product": {
"description": "Contains the details of a product.",
"id": "Product",
@@ -3201,6 +4089,106 @@
},
"type": "object"
},
+"SapSystemS4Config": {
+"description": "Message for sap system workload",
+"id": "SapSystemS4Config",
+"properties": {
+"allowStoppingForUpdate": {
+"type": "boolean"
+},
+"ansibleRunnerServiceAccount": {
+"description": "Ansible runner service account - let custoemrs bring their own SA for Ansible runner",
+"type": "string"
+},
+"app": {
+"$ref": "AppDetails",
+"description": "instance details"
+},
+"database": {
+"$ref": "DatabaseDetails",
+"description": "database details"
+},
+"deploymentModel": {
+"description": "Required. two model non-HA and HA supported",
+"enum": [
+"DEPLOYMENT_MODEL_UNSPECIFIED",
+"DISTRIBUTED",
+"DISTRIBUTED_HA"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"environmentType": {
+"description": "Required. deployment environment",
+"enum": [
+"ENVIRONMENT_TYPE_UNSPECIFIED",
+"NON_PRODUCTION",
+"PRODUCTION"
+],
+"enumDescriptions": [
+"Unspecified environment type",
+"Non-production environment type",
+"Production environment type"
+],
+"type": "string"
+},
+"gcpProjectId": {
+"description": "the project that infrastructure deployed, current only support the same project where the deployment resource exist.",
+"type": "string"
+},
+"location": {
+"$ref": "LocationDetails",
+"description": "database details"
+},
+"mediaBucketName": {
+"description": "Required. media_bucket_name",
+"type": "string"
+},
+"sapBootDiskImage": {
+"description": "Optional. sap_boot_disk_image",
+"type": "string"
+},
+"scalingMethod": {
+"description": "Required. support scale up and scale out",
+"enum": [
+"SCALE_METHOD_UNSPECIFIED",
+"SCALE_UP",
+"SCALE_OUT"
+],
+"enumDescriptions": [
+"",
+"Scale up: Increases the size of a physical machine by increasing the amount of RAM and CPU available for processing",
+"Scale out: Combines multiple independent computers into one system"
+],
+"type": "string"
+},
+"version": {
+"description": "Required. sap hana version",
+"enum": [
+"VERSION_UNSPECIFIED",
+"S4_HANA_2021",
+"S4_HANA_2022",
+"S4_HANA_2023"
+],
+"enumDescriptions": [
+"",
+"",
+"",
+""
+],
+"type": "string"
+},
+"vmPrefix": {
+"description": "vm_prefix",
+"type": "string"
+}
+},
+"type": "object"
+},
"SapValidation": {
"description": "A presentation of SAP workload insight. The schema of SAP workloads validation related data.",
"id": "SapValidation",
@@ -3392,6 +4380,224 @@
},
"type": "object"
},
+"SqlLocationDetails": {
+"description": "Location and networking details for configuring SQL server workload",
+"id": "SqlLocationDetails",
+"properties": {
+"dnsZone": {
+"description": "Optional. create a new DNS Zone when the field is empty, Only show for `Using an existing DNS` List of existing DNS Zones tf variable name: existing_dns_zone_name",
+"type": "string"
+},
+"gcpProjectId": {
+"description": "Required. the project that infrastructure deployed, currently only supports the same project where the deployment resource exists.",
+"type": "string"
+},
+"internetAccess": {
+"description": "Required. Internet Access",
+"enum": [
+"INTERNET_ACCESS_UNSPECIFIED",
+"ALLOW_EXTERNAL_IP",
+"CONFIGURE_NAT"
+],
+"enumDescriptions": [
+"Unspecified internet access",
+"Allow external IP",
+"Configure NAT"
+],
+"type": "string"
+},
+"network": {
+"description": "Required. network name",
+"type": "string"
+},
+"primaryZone": {
+"description": "Required. primary zone",
+"type": "string"
+},
+"region": {
+"description": "Required. region name",
+"type": "string"
+},
+"secondaryZone": {
+"description": "Optional. secondary zone can't be same as primary_zone and is only for High Availability deployment mode",
+"type": "string"
+},
+"subnetwork": {
+"description": "Required. subnetwork name",
+"type": "string"
+},
+"tertiaryZone": {
+"description": "Optional. teriary zone can't be same as primary_zone and secondary zone, and it is only for High Availability deployment mode",
+"type": "string"
+}
+},
+"type": "object"
+},
+"SqlServerWorkload": {
+"description": "Message for MS SQL workload",
+"id": "SqlServerWorkload",
+"properties": {
+"activeDirectory": {
+"$ref": "ActiveDirectory",
+"description": "Required. active directory details"
+},
+"computeEngineServiceAccount": {
+"description": "Compute engine service account - let customers bring their own SA for Compute engine",
+"type": "string"
+},
+"database": {
+"$ref": "Database",
+"description": "Required. database details"
+},
+"deploymentModel": {
+"description": "Required. HIGH_AVAILABILITY or SINGLE_INSTANCE",
+"enum": [
+"DEPLOYMENT_MODEL_UNSPECIFIED",
+"HIGH_AVAILABILITY",
+"SINGLE_INSTANCE"
+],
+"enumDescriptions": [
+"Unspecified deployment model",
+"High Availability deployment model",
+"Single Instance deployment model"
+],
+"type": "string"
+},
+"environmentType": {
+"description": "Required. deployment environment",
+"enum": [
+"ENVIRONMENT_TYPE_UNSPECIFIED",
+"NON_PRODUCTION",
+"PRODUCTION"
+],
+"enumDescriptions": [
+"Unspecified environment type",
+"Non-production environment type",
+"Production environment type"
+],
+"type": "string"
+},
+"fciType": {
+"description": "Optional. SHARED_DISK or S2D",
+"enum": [
+"FCI_TYPE_UNSPECIFIED",
+"SHARED_DISK",
+"S2D"
+],
+"enumDescriptions": [
+"Unspecified FCI type",
+"SHARED DISK FCI type",
+"S2D FCI type"
+],
+"type": "string"
+},
+"haType": {
+"description": "Optional. AOAG or FCI, it is only needed for High Availability deployment mode",
+"enum": [
+"HA_TYPE_UNSPECIFIED",
+"AOAG",
+"FCI"
+],
+"enumDescriptions": [
+"Unspecified HA type",
+"AOAG HA type",
+"FCI HA type"
+],
+"type": "string"
+},
+"isSqlPayg": {
+"description": "Required. SQL licensing type",
+"type": "boolean"
+},
+"location": {
+"$ref": "SqlLocationDetails",
+"description": "Required. location details"
+},
+"mediaBucket": {
+"description": "Required. name of the media storing SQL server installation files",
+"type": "string"
+},
+"operatingSystemType": {
+"description": "Required. type of the operating system the SQL server is going to run on top of",
+"enum": [
+"OPERATING_SYSTEM_TYPE_UNSPECIFIED",
+"WINDOWS",
+"UBUNTU",
+"RED_HAT_ENTERPRISE_LINUX",
+"SUSE"
+],
+"enumDescriptions": [
+"Unspecified operating system type",
+"Windows operating system type",
+"Ubuntu operating system type",
+"Red Hat Enterprise Linux operating system type",
+"Suse operating system type"
+],
+"type": "string"
+},
+"osImage": {
+"description": "Required. the image of the operating system",
+"type": "string"
+},
+"osImageType": {
+"description": "Optional. OS image type, it's used to create boot disks for VM instances When either Windows licensing type or SQL licensing type is BYOL, this option is disabled and default to custom image",
+"enum": [
+"OS_IMAGE_TYPE_UNSPECIFIED",
+"PUBLIC_IMAGE",
+"CUSTOM_IMAGE"
+],
+"enumDescriptions": [
+"Unspecified OS image type",
+"Public image",
+"Custom image"
+],
+"type": "string"
+},
+"pacemaker": {
+"$ref": "Pacemaker",
+"description": "Optional. pacemaker configuration, only applicable for Linux HA deployments"
+},
+"sqlServerEdition": {
+"description": "Optional. SQL Server Edition type, only applicable when Operating System is Linux",
+"enum": [
+"SQL_SERVER_EDITION_TYPE_UNSPECIFIED",
+"SQL_SERVER_EDITION_TYPE_DEVELOPER",
+"SQL_SERVER_EDITION_TYPE_ENTERPRISE",
+"SQL_SERVER_EDITION_TYPE_STANDARD",
+"SQL_SERVER_EDITION_TYPE_WEB"
+],
+"enumDescriptions": [
+"Unspecified type",
+"Developer type",
+"Enterprise type",
+"Standard type",
+"Web type"
+],
+"type": "string"
+},
+"sqlServerVersion": {
+"description": "Optional. 2017 or 2019 or 2022",
+"enum": [
+"SQL_SERVER_VERSION_TYPE_UNSPECIFIED",
+"SQL_SERVER_VERSION_TYPE_2017",
+"SQL_SERVER_VERSION_TYPE_2019",
+"SQL_SERVER_VERSION_TYPE_2022"
+],
+"enumDescriptions": [
+"Unspecified type",
+"2017 type",
+"2019 type",
+"2022 type"
+],
+"type": "string"
+},
+"vmPrefix": {
+"description": "Required. should be unique in the project",
+"type": "string"
+}
+},
+"type": "object"
+},
"SqlserverValidation": {
"description": "A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data.",
"id": "SqlserverValidation",
@@ -3532,6 +4738,17 @@
},
"type": "object"
},
+"TerraformVariable": {
+"description": "In order to align with Infra Manager dependency, we create the same TerraformVariable message to represent a Terraform input variable, by following Infra Manager's API documentation: https://cloud.google.com/infrastructure-manager/docs/reference/rest A Terraform input variable.",
+"id": "TerraformVariable",
+"properties": {
+"inputValue": {
+"description": "Optional. Input variable value.",
+"type": "any"
+}
+},
+"type": "object"
+},
"TorsoValidation": {
"description": "The schema of torso workload validation data.",
"id": "TorsoValidation",